Hi, we need to correlate data that our product collects with customer information like: email, shipping address, items shipped, tracking information, etc. To do this we need to pull that information into our SQL database, we only need to do this once a day. Would each of these need to be a separate API call or is there a way to everything all at once?
I’m not sure what you mean by email, shipping address, etc. Are you talking about information from orders?
You can get any order information from an order, which often has the information from the sales channel.
What version of the app is your product on?
Have you taken a look at the API documentation?
Look forward to helping,
Sophie
Yes I want the information for the order, as well as the shipping information. This would be on V3.
It looks like most information can be accessed through the /order request. How do I get the information in the “comments” field, that is highlighted in this page? https://support.ordoro.com/how-do-i-track-the-serial-numbers-of-the-products-in-each-shipment/
Here is a truncated version of the json schema for the order response, which can be found in the documentation. You’ll find comments, tracking_number, and more in it.
{
"additionalProperties": false,
"properties": {
"additional_cart_info": {
"properties": {
"is_prime": {
"type": "boolean"
}
},
"type": "object"
},
"audit_label": {
"items": {
"type": "object"
},
"type": "array"
},
"barcode": {
"type": "string"
},
"billing_address": {
...
"title": "Address Schema",
"type": "object"
},
"comments": {
"items": {
"properties": {
"date": {
"type": "string"
},
"text": {
"type": "string"
},
"user": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"created_date": {
"type": "string"
},
"dropshipping_info": {
"additionalProperties": false,
"properties": {
"instructions": {
"type": [
"string",
"null"
]
},
"requested_date": {
"format": "date-time",
"type": [
"string",
"null"
]
},
"requested_shipping_method": {
"type": [
"string",
"null"
]
},
"show_price": {
"type": "boolean"
},
"supplier": {
"properties": {
"id": {
"type": "integer"
},
"link": {
"type": "string"
}
},
"type": "object"
}
},
"title": "Dropshipping Info Schema",
"type": "object"
},
"financial": {
"additionalProperties": false,
"properties": {
"credit_card_issuer": {
"type": [
"string",
"null"
]
},
"discount_amount": {
"description": "Not calculated",
"type": [
"number",
"null"
]
},
"grand_total": {
"description": "Not calculated",
"type": [
"number",
"null"
]
},
"product_amount": {
"description": "Not calculated",
"type": [
"number",
"null"
]
},
"shipping_amount": {
"description": "Not calculated",
"type": [
"number",
"null"
]
},
"tax_amount": {
"description": "Not calculated",
"type": [
"number",
"null"
]
}
},
"title": "Order Financial Schema",
"type": "object"
},
"is_order_parent": {
"type": "boolean"
},
"lines": {
"items": {
"properties": {
"details": {
"type": [
"string",
"null"
]
},
"item_price": {
"type": "number"
},
"link": {
"type": "string"
},
"order_line_product_name": {
"type": "string"
},
"product_link": {
"type": "string"
},
"product_name": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"shippability": {
"properties": {
"is_dropship": {
"type": "boolean"
},
"shippability": {
"type": "string"
},
"supplier_id": {
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"sku": {
"type": "string"
},
"supplier_price": {
"type": [
"number",
"null"
]
}
},
"required": [
"quantity",
"item_price",
"supplier_price",
"link",
"product_name",
"product_link",
"sku",
"shippability",
"details"
],
"type": "object"
},
"type": "array"
},
"link": {
"type": "string"
},
"notes_from_customer": {
"type": [
"string",
"null"
]
},
"order_number": {
"type": "string"
},
"order_placed_date": {
"type": "string"
},
"parent_order_number": {
"type": [
"string",
"null"
]
},
"requested_shipping_method": {
"type": [
"string",
"null"
]
},
"return_shipping_info": {
"additionalProperties": false,
"properties": {
"box_shape": {
"type": [
"string",
"null"
]
},
"carrier": {
"properties": {
"id": {
"type": "integer"
},
"link": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"carrier_name": {
"type": [
"string",
"null"
]
},
"cost": {
"type": "number"
},
"created_date": {
"type": "string"
},
"customs_info": {
"items": {
"additionalProperties": false,
"properties": {
"country": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"quantity": {
"type": [
"integer",
"null"
]
},
"value": {
"description": "Dollar value of customs line",
"format": "double",
"type": [
"number",
"null"
]
},
"weight": {
"description": "Weight of customs line in ounces",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"display_shipping_method": {
"type": [
"string",
"null"
]
},
"has_additional_docs": {
"type": "boolean"
},
"has_label": {
"type": "boolean"
},
"height": {
"description": "Height in inches",
"type": [
"number",
"null"
]
},
"length": {
"description": "Length in inches",
"type": [
"number",
"null"
]
},
"packages": {
"items": {
"type": "object"
},
"type": [
"array",
"null"
]
},
"presets": {
"items": {
"type": "integer"
},
"type": "array"
},
"return_to": {
"additionalProperties": false,
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"company": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"street1": {
"type": [
"string",
"null"
]
},
"street2": {
"type": [
"string",
"null"
]
},
"validation": {
"additionalProperties": false,
"properties": {
"additional_text": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"unvalidated",
"validated",
"warning",
"error"
],
"type": "string"
},
"suggested": {
"items": {
"additionalProperties": false,
"properties": {
"city": {
"type": "string"
},
"country_code": {
"type": "string"
},
"is_commercial": {
"default": false,
"type": "boolean"
},
"state": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": [
"string",
"null"
]
},
"zip": {
"type": "string"
}
},
"required": [
"city",
"state",
"zip",
"street1"
],
"title": "Suggested Address",
"type": "object"
},
"type": "array"
}
},
"required": [
"status",
"additional_text",
"suggested"
],
"title": "Validation status of an Address",
"type": [
"object",
"null"
]
},
"zip": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"zip",
"country",
"email",
"phone",
"validation"
],
"title": "Address Schema",
"type": "object"
},
"ship_date": {
"format": "date-time",
"type": [
"string",
"null"
]
},
"ship_from": {
"additionalProperties": false,
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"company": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"street1": {
"type": [
"string",
"null"
]
},
"street2": {
"type": [
"string",
"null"
]
},
"validation": {
"additionalProperties": false,
"properties": {
"additional_text": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"unvalidated",
"validated",
"warning",
"error"
],
"type": "string"
},
"suggested": {
"items": {
"additionalProperties": false,
"properties": {
"city": {
"type": "string"
},
"country_code": {
"type": "string"
},
"is_commercial": {
"default": false,
"type": "boolean"
},
"state": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": [
"string",
"null"
]
},
"zip": {
"type": "string"
}
},
"required": [
"city",
"state",
"zip",
"street1"
],
"title": "Suggested Address",
"type": "object"
},
"type": "array"
}
},
"required": [
"status",
"additional_text",
"suggested"
],
"title": "Validation status of an Address",
"type": [
"object",
"null"
]
},
"zip": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"zip",
"country",
"email",
"phone",
"validation"
],
"title": "Address Schema",
"type": "object"
},
"shipping_method": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"tracking_number": {
"type": [
"string",
"null"
]
},
"tracking_url": {
"type": [
"string",
"null"
]
},
"width": {
"description": "Width in inches",
"type": [
"number",
"null"
]
}
},
"title": "Shipping Info Schema",
"type": "object"
},
"sales_channel": {
"properties": {
"id": {
"type": "integer"
},
"link": {
"type": "string"
}
},
"type": "object"
},
"shippability": {
"type": "string"
},
"shipping_address": {
"additionalProperties": false,
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"company": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"street1": {
"type": [
"string",
"null"
]
},
"street2": {
"type": [
"string",
"null"
]
},
"validation": {
"additionalProperties": false,
"properties": {
"additional_text": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"unvalidated",
"validated",
"warning",
"error"
],
"type": "string"
},
"suggested": {
"items": {
"additionalProperties": false,
"properties": {
"city": {
"type": "string"
},
"country_code": {
"type": "string"
},
"is_commercial": {
"default": false,
"type": "boolean"
},
"state": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": [
"string",
"null"
]
},
"zip": {
"type": "string"
}
},
"required": [
"city",
"state",
"zip",
"street1"
],
"title": "Suggested Address",
"type": "object"
},
"type": "array"
}
},
"required": [
"status",
"additional_text",
"suggested"
],
"title": "Validation status of an Address",
"type": [
"object",
"null"
]
},
"zip": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"zip",
"country",
"email",
"phone",
"validation"
],
"title": "Address Schema",
"type": "object"
},
"shipping_info": {
"additionalProperties": false,
"properties": {
"box_shape": {
"type": [
"string",
"null"
]
},
"carrier": {
"properties": {
"id": {
"type": "integer"
},
"link": {
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"carrier_name": {
"type": [
"string",
"null"
]
},
"cost": {
"type": "number"
},
"created_date": {
"type": "string"
},
"customs_info": {
"items": {
"additionalProperties": false,
"properties": {
"country": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"quantity": {
"type": [
"integer",
"null"
]
},
"value": {
"description": "Dollar value of customs line",
"format": "double",
"type": [
"number",
"null"
]
},
"weight": {
"description": "Weight of customs line in ounces",
"type": [
"number",
"null"
]
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"display_shipping_method": {
"type": [
"string",
"null"
]
},
"has_additional_docs": {
"type": "boolean"
},
"has_label": {
"type": "boolean"
},
"height": {
"description": "Height in inches",
"type": [
"number",
"null"
]
},
"length": {
"description": "Length in inches",
"type": [
"number",
"null"
]
},
"packages": {
"items": {
"type": "object"
},
"type": [
"array",
"null"
]
},
"presets": {
"items": {
"type": "integer"
},
"type": "array"
},
"return_to": {
"additionalProperties": false,
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"company": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"street1": {
"type": [
"string",
"null"
]
},
"street2": {
"type": [
"string",
"null"
]
},
"validation": {
...
},
"zip": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"zip",
"country",
"email",
"phone",
"validation"
],
"title": "Address Schema",
"type": "object"
},
"ship_date": {
"format": "date-time",
"type": [
"string",
"null"
]
},
"ship_from": {
"additionalProperties": false,
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"company": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"street1": {
"type": [
"string",
"null"
]
},
"street2": {
"type": [
"string",
"null"
]
},
"validation": {
"additionalProperties": false,
"properties": {
"additional_text": {
"type": [
"string",
"null"
]
},
"status": {
"enum": [
"unvalidated",
"validated",
"warning",
"error"
],
"type": "string"
},
"suggested": {
"items": {
"additionalProperties": false,
"properties": {
"city": {
"type": "string"
},
"country_code": {
"type": "string"
},
"is_commercial": {
"default": false,
"type": "boolean"
},
"state": {
"type": "string"
},
"street1": {
"type": "string"
},
"street2": {
"type": [
"string",
"null"
]
},
"zip": {
"type": "string"
}
},
"required": [
"city",
"state",
"zip",
"street1"
],
"title": "Suggested Address",
"type": "object"
},
"type": "array"
}
},
"required": [
"status",
"additional_text",
"suggested"
],
"title": "Validation status of an Address",
"type": [
"object",
"null"
]
},
"zip": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"company",
"street1",
"street2",
"city",
"state",
"zip",
"country",
"email",
"phone",
"validation"
],
"title": "Address Schema",
"type": "object"
},
"shipping_method": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"tracking_number": {
"type": [
"string",
"null"
]
},
"tracking_url": {
"type": [
"string",
"null"
]
},
"width": {
"description": "Width in inches",
...
}
},
"title": "Shipping Info Schema",
"type": "object"
},
"status": {
"type": "string"
},
"tags": {
...
},
"type": "array"
},
"updated_date": {
"type": "string"
},
"warehouse": {
"properties": {
"id": {
"type": "integer"
},
"link": {
"type": "string"
}
},
"type": "object"
},
"weight": {
"description": "Weight in ounces",
"type": "number"
}
},
...
"title": "Order Schema",
"type": "object"
}
I don’t believe that particular information is surfaced in the api in v3, however.
One place to check might be details on an order line.
It looks like if I do /order/order_number/line/order_line_id then I can get the details for that line. But I assume that is the “Additional Details” section, and not the “comments” section that the help page suggests serial numbers go in.