Orders
Index
Get a list of all orders.
GET
/orders
Example Response
{
"orders": [
{
"id": 1,
"created_at": "2022-03-22T13:02:07.000000Z",
"updated_at": "2022-03-22T13:02:07.000000Z",
"customer_id": 1,
"shipping_address_id": 28,
"billing_address_id": 28,
"order_id": "AYV-411841-64",
"channel_id": 1,
"channel_order_id": "CGZ-211973-62",
"order_date": "2022-03-19 09:02:06",
"ship_by": "2022-03-23 09:02:06",
"arrive_by": "2022-03-25 09:02:06",
"status": "pending",
"warehouse_notes": "Omnis occaecati non ab inventore expedita cupiditate in tempore.",
"gift_note": "Atque voluptatibus et dolor sed.",
"shipping_method_preference": "qui",
"should_fulfill": true,
"pick_assigned_to": null,
"pack_assigned_to": null,
"quotes": null,
"errors": null,
"order_items_count": 1,
"order_items": [
{
"id": 1,
"created_at": null,
"updated_at": null,
"order_id": 1,
"item_id": 11,
"listing_id": null,
"quantity": 1,
"picked_at": null,
"pick_data": null,
"item": {
"id": 11,
"created_at": "2022-03-22T13:02:02.000000Z",
"updated_at": "2022-03-22T13:02:06.000000Z",
"team_id": 2,
"merchant_sku": "OI-Small-Co-696383",
"title": "Small Concrete Car",
"condition": "new",
"condition_note": null,
"bundle_id": null,
"length_mm": 143,
"width_mm": 71,
"height_mm": 76,
"weight_gm": 225,
"fnsku": "X00N7WF8MY",
"asin": "B07LDTNHS1",
"searchableIdentifiers": "B07LDTNHS1,X00N7WF8MY,0751765057210",
"images": [
{
"id": 11,
"path": null,
"large_url": "https:\/\/source.unsplash.com\/collection\/345710\/1500x1500?sig=11",
"thumbnail_url": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAjVBMVEX\/\/\/8jHyAAAAAWEBJ7eXkTDA4QCAvp6OiLiYogHB0cFxgdGBkeGhsYExQJAADx8fHAv78MAAX5+fmTkZK\/vr7Hxsb09PRIRUbNzMxBPj9samva2dm4t7eYlpdPTE12dHXU1NRbWVlkYmIsKCmdnJw3NDXi4uKvrq4zMDGGhIVNSkqnpqZfXV1VU1NFQkOurYy8AAAJQUlEQVR4nO2da3uqOhCFJVRaBKF4r5ZqrbX3\/f9\/3ol6rBdmYTKCYJ9ZX7ey83bW5EYyNhoikUgkEolEIpFIJBKJRCKRSCQSiUSEOrPRrFN1I8rU4l0p9b6ouhllabBIIt9xHD+JFoOqG1OCBgtnzbeSH\/npX2PsLN5\/+TaML38rjgs\/2edbMyZB+lf6nMGiHR3zbeLYXMRVN64ADb5eSL4No3P1jJ0U8\/2fj1ft1c7Cy+RfhtFLrrZfHSzC3Pjt+px2eo1eHSxof7bpfLw+xtSh+HxPTZVH\/UPid6tuso0Gi4jKP98L7+LGoJsdHDfwVxPH\/fnZYZjuNghxF3wguApGkH++F3Vvfz8UpwnpVT121L1f7aQubcHm3WHTO12XZPSa3TozxgsX+LObtd8AdEaJR3y4Horp\/HOS1p4\/D76Q6mGCYgxrmY9gfqa7yJyQxCkYO5zaeTVOwfgQ3OU3tQPHjlp5ddCFw\/jpZsYoH93aMA7Sl4RIJ0d3i3T+HStO22QctVfrwNhJkc3uzJuHTOAFleej7ipoPt+yaYOuU8d8jNOAXP\/5r4xmgbmc41WXjwPQJMcJhzPOA3WHjMaOKhgH9NTyf0T1M+M8tNNt0\/kYXTwf47SZvz\/RUs8jzoPRXM5LLhpHPYSd3H9x2uqbxRinITX4rPrVSzF26G6PYIx+mIxg7PBPTJCKEfrv3RbB2FJPLEbwR7zE2BF326SFEufjR9GM3DiCscOzmEgw\/lv0p\/VW87P7TxUSbWqr5z7rP0vBGtkvjXGAluXRNj3uH8g4ttUnr1\/tevR\/6JaSj3HXZDjuPwGv8vIRTCpWk16zSb254m6L7D+T8Dj171E+cr0K8tF04WImu2lx\/5P2avTEZIRjR1H5iPzptVA6QK8OmWNHQDfAZoGGFXebjPV7n\/ZqoHhxxHO5s\/Nx+eGT82u4f\/ar\/jMaH5lebdFzudbHkvO8rZA\/lclUfzREXuXFEewDNKMz3ul0FRgfDF\/bjn4U9TItUA8sRjSXU2zEJfE8s\/2zX42eASOzXyXHRz\/hGjXNOt9LbLejRygfn+45bVrN5TIPS1LOo7TGmT+\/zzlWALzaUv94Xk0zj2qPOQ9qkIQfrM559A28OmTE8fajOMKpm3lWM7pheX40R\/loybj88JqZx7hTTpu0brKEmtGdsuI4o\/ucllUcb2+aTaI3dW84LWoAQr2aV1NWHGfIqw+GjMupovgKJ1w9kcs4jyjGUA17p7+8vFGwPYUTaq960wnnkTOUj5+P+V+cTIn8K5NQPzUas+I4QfmY59XlNMF8ZRGuNifGrDhO5hH14FC9Aq8ux9CfxRHSK3wu44xuckDm42RKfthPdlOlAgjdjzf6FKybMOM4RnOAx+MPkvnnR97bx6555xM27xqdr5eI3iycM70K4rjvVeDP1cnbTuPuF70YQq2vd7AhymQcJzTjQ2\/7ATLQfvTytZoel0Co4\/hOrRhX+ThjMU5JhHDtVZCsvnr52iy\/yyBcMQY0Y\/TNiuOSDpOey8092p\/u13Z5Uw5hI8erzzMeI+1ValEZan\/uvlkaoY7jK\/DqnMU4mZKM2fip16\/95Wl5hJrx7QUxsjZEwZB3xOe8HS6\/yyTU0oyFevUEYxg5X8ffKZlQM76qgGgL9wX+cupRj9vwqfe37DdKJ9SMD6RXW8wX+Msh5Yp1\/r1R20MXIGw0HoFXOS\/wZ98gfsf5t9VFCDXjK8lo\/cJwhjaPKX9udCHCtVdpRos4gk1VvaCCfBckbHQeUT4avoTp04tilH9bXY6wAfPRyKtgwziMVGZ8ONRFCTXjAxg7Tmxsj+gXxkGuPze6MKFmHJKMQZ5XwUvGUP07yVcBYaPRQ3EEG9t94E\/1fmLjbaMKCHMY\/2UZwYEG3X8a8VVEqBn\/gbw62izs0y+I9ecM+Soj1Iz04a9APe02YMChG51\/xnwVEq4Pf+V6FfvTYHN\/pwoJNSPyqmYAh99avxtQpqqUUHuVPjQUKh\/MDT4t+SonXB+MorxKze94L4MrJ9SMtFezfKYvEA9VA0J4wG1f3ANENSGE48KO78k6\/7aqCWFuHAN2\/FaqDaFeP8DDmGfw1YpwNcfOvMBvMQ9+7VQrwvWhof045q6pDFUzwtVafofY+jybr4aEjXh35M4r4vRy\/Qhv9wiLOGcvhAYSQksJoa2E0EBCaCkhtJUQGkgILSWEthJCAwmhpYTQVkJoICG0lBDaSggNJISWEkJbCaGBhNBSQmgrITSQEFqq1oQO8+L2gYolXI53tcALucvdVrwL+HsqkvDwLlhBt9Xd5Mw4Fke4PCo\/UNh9fFedxVgUYfb6M5swW2PoLK8WQ7gk7g4n3N+qmxB1\/d2IdwG\/UQzhZEzVY4jYf\/apyj6NXRCjAEJwZ1hxC\/BozUG1zjmH8VxCcO87UHPGw371OASXYRn5eB4huLsfWB3vJwUuiTDy8RzC5Zi8nm9+\/SRXPfrCbzuyLBbBJ1yS\/Yvx9SEDPdIHti0LYnAJYf6ZX68x0COqgmxREINHCO7q212vMVKPvgzrmnuVQ0iPf6urKUXzrQQrPRsy2hMa1bApVNqrZJ9j5lVbwtzaLqWpR18UdU0Y7QiBP8Ni+xdK\/LHDhhCMD0Fx40OeYD6eKMJjTrik69bZX29jq0df2jqRj6aEM3r8C0\/W5StU93Q+aq\/O4HfMCEG9uuBy8duqb+1VE8IJqqt4cb6VeqC6PCqmdJoQlC9rlTs+5Oke5SPJeIoQ5F\/AuF5aoMClZnKek08Ix7\/S5i+mAhdFiYJReYQg\/\/Jrfl5M4BJlxquYEPqTf\/2yYPXRfPV7tvcpRDhD4wNRaqI6Qa\/uMdKEE7q2MPf6c4lCv0yyy0eKcELXhyZLhVQvnI+bQkNZwvrn37H6YC638eoxIfBnWM\/4bQWKsqy9ekgI\/Vm7\/DsW9mpvF9\/WPZqf1daf++r\/0F7df5OVFPM7ApUJ5GO+uL\/NUpFGw8ik6MdO55YfqEDgF58Q38+1+HNfBoVNtv4s4np+JQK\/+HQcv6vKv2MRBTGO+a6m\/0QChQO3\/jy\/PEYNBIq3nFueplbSjFmvXuH4kKeMV690fMjTaH985P7uWs012u51hMzfI7sCjR6U226qB1a57ytR\/2Z881fjJxKJRCKRSCQSiUQikUgkEolEIpHoTP0HQMK6qG8e9HsAAAAASUVORK5CYII=",
"imageable_id": 11,
"imageable_type": "App\\Models\\Item"
}
],
"identifiers": [
{
"id": 21,
"created_at": "2022-03-22T13:02:03.000000Z",
"updated_at": "2022-03-22T13:02:03.000000Z",
"item_id": 11,
"identifier": "B07LDTNHS1",
"identifier_type": "ASIN"
},
{
"id": 22,
"created_at": "2022-03-22T13:02:03.000000Z",
"updated_at": "2022-03-22T13:02:03.000000Z",
"item_id": 11,
"identifier": "X00N7WF8MY",
"identifier_type": "FNSKU"
},
{
"id": 302,
"created_at": "2022-03-22T13:02:06.000000Z",
"updated_at": "2022-03-22T13:02:06.000000Z",
"item_id": 11,
"identifier": "0751765057210",
"identifier_type": "EAN"
}
]
}
}
],
"customer": {
"id": 1,
"created_at": "2022-03-22T13:02:06.000000Z",
"updated_at": "2022-03-22T13:02:07.000000Z",
"name": "Paucek, Nicolas and Kihn",
"team_id": 2,
"channel_id": 1,
"default_address_id": 3,
"email": "joberbrunner@hermiston.com",
"phone_number": "+1-270-754-2271",
"email_hash": "818614d1f12599d32f5a7739af95e8bdc425d3ab91102852a4ad2e481233467c",
"name_address_hash": "0f375594f6f3f9dbd730fdf825463a6950da634a014c81dc176e2c46b91ac957"
}
}
]
}Upload Orders
Create new orders in bulk
For this call, you are required to set the merchant using the Merchant Header.
POST
/orders/upload
| Parameter | Type | Examples | Description |
|---|---|---|---|
channel_id
| integer | 5 | The ID of the sales channel the orders were placed on |
orders
| array<Order> | [...] | An array of orders to upload |
orders.*.name
| string | Jane Doe | The name of the customer that placed the order. Required if first_name and last_name are not set. |
orders.*.first_name
| string | Jane | The first name of the customer that placed the order. Required if name is not set. |
orders.*.last_name
| string | Doe | The last name of the customer that placed the order. Required if name is not set. |
orders.*.email
| janedoe@gmail.com | The email address of the customer that placed the order. | |
orders.*.phone
| string | +1 555 555 5555 | The phone number of the customer that placed the order. |
orders.*.address_line_1
| string | 123 Example St | The first line of the shipping address for the customer that placed the order. |
orders.*.address_line_2
| string | Apt 2 | The second line of the shipping address for the customer that placed the order. |
orders.*.address_line_3
| string | C/O John Doe | The third line of the shipping address for the customer that placed the order. |
orders.*.city
| string | New York | The city of the shipping address for the customer that placed the order. |
orders.*.state_province
| string | NY | The province or state of the shipping address for the customer that placed the order. |
orders.*.country
| string | United States | The country of the shipping address for the customer that placed the order. Required without country_code. |
orders.*.country_code
| string | US | The country code of the shipping address for the customer that placed the order. Required without country, and is the more reliable way to set the country. |
orders.*.postal_code
| string | 21222 | The postal code / ZIP of the shipping address for the customer that placed the order. |
orders.*.is_residential
| boolean | true | If the shipping address for the customer that placed the order is a residential address. |
orders.*.order_id
| string | ORDER-ABC-1234 | A unique string that identifies this order |
orders.*.order_date
| date | 2022-03-22 | The date this order was placed |
orders.*.gift_note
| string | Congratulations! | A gift note to be included with the order |
orders.*.items
| array<Item> | See the orders.*.items.* parameters | The items contained in the order |
orders.*.items.*.merchant_sku
| string | FLN-A-1554 | The SKU of the item matching. This should be consistent across all channels |
orders.*.items.*.quantity
| integer | 2 | The quantity of this item that was ordered |
orders.*.items.*.title
| string | Wall-mounted Fan Unit, 18 inch | The title of this item. This will only be used if the item does not already exist on the portal. |
Example Response
{
"message": "Orders uploaded"
}Show
Get the details of a single order.
GET
/orders/{ORDER_ID}
Example Response
{
"order": {
"id": 8,
"created_at": "2022-09-29T20:51:03.000000Z",
"updated_at": "2022-10-05T00:41:39.000000Z",
"customer_id": 8,
"shipping_address_id": 11,
"billing_address_id": 11,
"order_id": "ANX-352231-61",
"channel_id": 1,
"channel_order_id": "CWM-286025-86",
"order_date": "2022-09-28 16:51:03",
"ship_by": "2022-09-30 16:51:03",
"arrive_by": "2022-10-04 16:51:03",
"status": "shipped",
"warehouse_notes": "Omnis et ad veniam.",
"gift_note": "Aperiam sunt molestiae qui quas quis.",
"shipping_method_preference": "explicabo",
"should_fulfill": true,
"pick_assigned_to": null,
"pack_assigned_to": 16,
"quotes": {
"selected_quote_id": "d199cdf0-055c-5290-a0f0-ae744689855f",
"cheapest_quote_id": "d199cdf0-055c-5290-a0f0-ae744689855f",
"fastest_quote_id": "9facdc6b-dc10-5ecd-8058-3b4bba641e19",
"preference_quote_ids": [],
"quotes": [
{
"id": "d1ba9f18-1669-5f2a-90c6-38808437d65d",
"total": {
"amount": "24.85",
"currency": "USD"
},
"carrier": "usps",
"service_level": "usps__express",
"provider": "vanlo",
"quote_items": [
{
"carrier_rate": {
"rate_id": "rate_fe465be3cc7fdd6e7fefbc45ab26e6fc",
"shipment_id": "shp_ff3a57d19471b5ca249808adf62cd667",
"carrier": "usps",
"service": "usps__express",
"rate": {
"amount": "24.85",
"currency": "USD"
},
"to_address_id": "adr_498907a4cb77571438e984eb8148794f",
"from_address_id": "adr_31ecf882087edf7c94884d9bc8ad4e64"
},
"parcels": [
{
"dimensions": {
"length": 5,
"width": 5,
"height": 5,
"weight": 72700
},
"internal_parcel_identifier": "pkg_Q5JymjnDxn8qoKl",
"carrier_parcel_id": "prcl_220ea47f6aa49d67cceca40f7de42ee1"
}
]
}
]
},
{
"id": "4958489d-31e5-515c-9068-bca107d4642d",
"total": {
"amount": "7.54",
"currency": "USD"
},
"carrier": "usps",
"service_level": "usps__priority",
"provider": "vanlo",
"delivery_date": "2022-10-07 00:00:00",
"delivery_days": 2,
"quote_items": [
{
"carrier_rate": {
"rate_id": "rate_5a9bf205b6b3935cd7da95ee7007c97d",
"shipment_id": "shp_ff3a57d19471b5ca249808adf62cd667",
"carrier": "usps",
"service": "usps__priority",
"rate": {
"amount": "7.54",
"currency": "USD"
},
"delivery_date": "2022-10-07 00:00:00",
"delivery_days": 2,
"to_address_id": "adr_498907a4cb77571438e984eb8148794f",
"from_address_id": "adr_31ecf882087edf7c94884d9bc8ad4e64"
},
"parcels": [
{
"dimensions": {
"length": 5,
"width": 5,
"height": 5,
"weight": 72700
},
"internal_parcel_identifier": "pkg_Q5JymjnDxn8qoKl",
"carrier_parcel_id": "prcl_220ea47f6aa49d67cceca40f7de42ee1"
}
]
}
]
},
{
"id": "d199cdf0-055c-5290-a0f0-ae744689855f",
"total": {
"amount": "6.86",
"currency": "USD"
},
"carrier": "usps",
"service_level": "usps__parcel_select",
"provider": "vanlo",
"delivery_date": "2022-10-07 00:00:00",
"delivery_days": 2,
"quote_items": [
{
"carrier_rate": {
"rate_id": "rate_8f751e69b3306ef143e016e4a4b1cb16",
"shipment_id": "shp_ff3a57d19471b5ca249808adf62cd667",
"carrier": "usps",
"service": "usps__parcel_select",
"rate": {
"amount": "6.86",
"currency": "USD"
},
"delivery_date": "2022-10-07 00:00:00",
"delivery_days": 2,
"to_address_id": "adr_498907a4cb77571438e984eb8148794f",
"from_address_id": "adr_31ecf882087edf7c94884d9bc8ad4e64"
},
"parcels": [
{
"dimensions": {
"length": 5,
"width": 5,
"height": 5,
"weight": 72700
},
"internal_parcel_identifier": "pkg_Q5JymjnDxn8qoKl",
"carrier_parcel_id": "prcl_220ea47f6aa49d67cceca40f7de42ee1"
}
]
}
]
},
{
"id": "66794d52-8354-5a05-aa55-5afffb879c78",
"total": {
"amount": "9.43",
"currency": "USD"
},
"carrier": "ups",
"service_level": "ups__3_day_select",
"provider": "shippo",
"delivery_days": 3,
"quote_items": [
{
"carrier_rate": {
"rate_id": "ba4fa662e44b4878b96f5e7b45ad160c",
"shipment_id": "9cfb43182b534565893df9499404046d",
"carrier": "ups",
"carrier_account_id": "d4f9889c105b4bfa9a2d0626d3798d44",
"service": "ups__3_day_select",
"rate": {
"amount": "9.43",
"currency": "USD"
},
"delivery_days": 3,
"to_address_id": "72c2577e158c44f69c38c82ef120ddb5",
"from_address_id": "519c4ba08dbc4247a98cbbfd7d0b0322"
},
"parcels": [
{
"dimensions": {
"length": 127,
"width": 127,
"height": 127,
"weight": 2061
},
"internal_parcel_identifier": "pkg_Q5JymjnDxn8qoKl",
"carrier_parcel_id": "4c36e20e76d74482aed7e07a5a74e2a2"
}
]
}
]
},
{
"id": "dcc0b7e7-c84e-53bf-9705-ff65e0b4842c",
"total": {
"amount": "10.59",
"currency": "USD"
},
"carrier": "ups",
"service_level": "ups__second_day_air",
"provider": "shippo",
"delivery_days": 2,
"quote_items": [
{
"carrier_rate": {
"rate_id": "9a0b6f7f22ce4a0e9757171613a8f118",
"shipment_id": "9cfb43182b534565893df9499404046d",
"carrier": "ups",
"carrier_account_id": "d4f9889c105b4bfa9a2d0626d3798d44",
"service": "ups__second_day_air",
"rate": {
"amount": "10.59",
"currency": "USD"
},
"delivery_days": 2,
"to_address_id": "72c2577e158c44f69c38c82ef120ddb5",
"from_address_id": "519c4ba08dbc4247a98cbbfd7d0b0322"
},
"parcels": [
{
"dimensions": {
"length": 127,
"width": 127,
"height": 127,
"weight": 2061
},
"internal_parcel_identifier": "pkg_Q5JymjnDxn8qoKl",
"carrier_parcel_id": "4c36e20e76d74482aed7e07a5a74e2a2"
}
]
}
]
},
{
"id": "da04a3d3-f819-54cd-8af1-3e8c3558296f",
"total": {
"amount": "11.98",
"currency": "USD"
},
"carrier": "ups",
"service_level": "ups__second_day_air_am",
"provider": "shippo",
"delivery_date": "2022-10-04 10:30:00",
"delivery_days": 2,
"quote_items": [
{
"carrier_rate": {
"rate_id": "58dc531578274c5ca88391f3aa1add60",
"shipment_id": "9cfb43182b534565893df9499404046d",
"carrier": "ups",
"carrier_account_id": "d4f9889c105b4bfa9a2d0626d3798d44",
"service": "ups__second_day_air_am",
"rate": {
"amount": "11.98",
"currency": "USD"
},
"delivery_date": "2022-10-04 10:30:00",
"delivery_days": 2,
"to_address_id": "72c2577e158c44f69c38c82ef120ddb5",
"from_address_id": "519c4ba08dbc4247a98cbbfd7d0b0322"
},
"parcels": [
{
"dimensions": {
"length": 127,
"width": 127,
"height": 127,
"weight": 2061
},
"internal_parcel_identifier": "pkg_Q5JymjnDxn8qoKl",
"carrier_parcel_id": "4c36e20e76d74482aed7e07a5a74e2a2"
}
]
}
]
},
{
"id": "9facdc6b-dc10-5ecd-8058-3b4bba641e19",
"total": {
"amount": "8.22",
"currency": "USD"
},
"carrier": "ups",
"service_level": "ups__ground",
"provider": "shippo",
"delivery_days": 1,
"quote_items": [
{
"carrier_rate": {
"rate_id": "9d51a94af62043c3892b7c048eb01c64",
"shipment_id": "9cfb43182b534565893df9499404046d",
"carrier": "ups",
"carrier_account_id": "d4f9889c105b4bfa9a2d0626d3798d44",
"service": "ups__ground",
"rate": {
"amount": "8.22",
"currency": "USD"
},
"delivery_days": 1,
"to_address_id": "72c2577e158c44f69c38c82ef120ddb5",
"from_address_id": "519c4ba08dbc4247a98cbbfd7d0b0322"
},
"parcels": [
{
"dimensions": {
"length": 127,
"width": 127,
"height": 127,
"weight": 2061
},
"internal_parcel_identifier": "pkg_Q5JymjnDxn8qoKl",
"carrier_parcel_id": "4c36e20e76d74482aed7e07a5a74e2a2"
}
]
}
]
},
{
"id": "2d5b4643-340a-5ce6-b6e1-ce132b89529d",
"total": {
"amount": "16.19",
"currency": "USD"
},
"carrier": "ups",
"service_level": "ups__next_day_air_saver",
"provider": "shippo",
"delivery_date": "2022-10-04 15:00:00",
"delivery_days": 1,
"quote_items": [
{
"carrier_rate": {
"rate_id": "29bef961645a4b1d9267e3bf461a5f45",
"shipment_id": "9cfb43182b534565893df9499404046d",
"carrier": "ups",
"carrier_account_id": "d4f9889c105b4bfa9a2d0626d3798d44",
"service": "ups__next_day_air_saver",
"rate": {
"amount": "16.19",
"currency": "USD"
},
"delivery_date": "2022-10-04 15:00:00",
"delivery_days": 1,
"to_address_id": "72c2577e158c44f69c38c82ef120ddb5",
"from_address_id": "519c4ba08dbc4247a98cbbfd7d0b0322"
},
"parcels": [
{
"dimensions": {
"length": 127,
"width": 127,
"height": 127,
"weight": 2061
},
"internal_parcel_identifier": "pkg_Q5JymjnDxn8qoKl",
"carrier_parcel_id": "4c36e20e76d74482aed7e07a5a74e2a2"
}
]
}
]
},
{
"id": "a5ce5d7a-de93-5016-b115-1502d39d120f",
"total": {
"amount": "20.89",
"currency": "USD"
},
"carrier": "ups",
"service_level": "ups__next_day_air",
"provider": "shippo",
"delivery_date": "2022-10-04 10:30:00",
"delivery_days": 1,
"quote_items": [
{
"carrier_rate": {
"rate_id": "0d07163720494f81aed426182deabbe8",
"shipment_id": "9cfb43182b534565893df9499404046d",
"carrier": "ups",
"carrier_account_id": "d4f9889c105b4bfa9a2d0626d3798d44",
"service": "ups__next_day_air",
"rate": {
"amount": "20.89",
"currency": "USD"
},
"delivery_date": "2022-10-04 10:30:00",
"delivery_days": 1,
"to_address_id": "72c2577e158c44f69c38c82ef120ddb5",
"from_address_id": "519c4ba08dbc4247a98cbbfd7d0b0322"
},
"parcels": [
{
"dimensions": {
"length": 127,
"width": 127,
"height": 127,
"weight": 2061
},
"internal_parcel_identifier": "pkg_Q5JymjnDxn8qoKl",
"carrier_parcel_id": "4c36e20e76d74482aed7e07a5a74e2a2"
}
]
}
]
},
{
"id": "ee89a457-1672-5429-bba5-b49c8399f052",
"total": {
"amount": "50.59",
"currency": "USD"
},
"carrier": "ups",
"service_level": "ups__next_day_air_early_am",
"provider": "shippo",
"delivery_date": "2022-10-04 08:30:00",
"delivery_days": 1,
"quote_items": [
{
"carrier_rate": {
"rate_id": "d968d26fd3494d68847eb4437b6d83b4",
"shipment_id": "9cfb43182b534565893df9499404046d",
"carrier": "ups",
"carrier_account_id": "d4f9889c105b4bfa9a2d0626d3798d44",
"service": "ups__next_day_air_early_am",
"rate": {
"amount": "50.59",
"currency": "USD"
},
"delivery_date": "2022-10-04 08:30:00",
"delivery_days": 1,
"to_address_id": "72c2577e158c44f69c38c82ef120ddb5",
"from_address_id": "519c4ba08dbc4247a98cbbfd7d0b0322"
},
"parcels": [
{
"dimensions": {
"length": 127,
"width": 127,
"height": 127,
"weight": 2061
},
"internal_parcel_identifier": "pkg_Q5JymjnDxn8qoKl",
"carrier_parcel_id": "4c36e20e76d74482aed7e07a5a74e2a2"
}
]
}
]
}
],
"messages": [
{
"source": "UPS",
"text": "RatedShipmentAlert: Your invoice may vary from the displayed reference rates"
}
],
"errors": []
},
"errors": null,
"deleted_at": null,
"currency": "USD",
"tote_code": null,
"tracking_numbers": [
{
"status": "unknown",
"number": "9461200205903141100394",
"carrier": "usps",
"service_level": "usps__parcel_select",
"eta": null,
"transit_at": null,
"delivered_at": null,
"returned_at": null,
"failed_at": null,
"package_identifier": "pkg_Q5JymjnDxn8qoKl",
"tracking_url": "https:\/\/tools.usps.com\/go\/TrackConfirmAction_input?qtc_tLabels1=9461200205903141100394",
"id": 436
}
],
"order_items": [
{
"id": 8,
"created_at": "2022-09-29T20:51:03.000000Z",
"updated_at": "2022-09-29T20:51:03.000000Z",
"order_id": 8,
"item_id": 6,
"listing_id": null,
"quantity": 1,
"picked_at": null,
"pick_data": null,
"external_id": null,
"item": {
"id": 6,
"created_at": "2022-09-29T20:51:02.000000Z",
"updated_at": "2022-09-29T20:51:02.000000Z",
"team_id": 1,
"merchant_sku": "OI-Ergonomic-873034",
"title": "Ergonomic Concrete Plate",
"condition": "new",
"condition_note": null,
"bundle_id": null,
"length_mm": 80,
"width_mm": 155,
"height_mm": 113,
"weight_gm": 1607,
"fnsku": "X003ULKERY",
"asin": "B08W3QKXI8",
"searchableIdentifiers": "B08W3QKXI8,X003ULKERY,8993160747972",
"images": [
{
"id": 6,
"path": null,
"large_url": "https:\/\/source.unsplash.com\/collection\/345710\/1500x1500?sig=6",
"thumbnail_url": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAMAAAAJbSJIAAAAjVBMVEX\/\/\/8jHyAAAAAWEBJ7eXkTDA4QCAvp6OiLiYogHB0cFxgdGBkeGhsYExQJAADx8fHAv78MAAX5+fmTkZK\/vr7Hxsb09PRIRUbNzMxBPj9samva2dm4t7eYlpdPTE12dHXU1NRbWVlkYmIsKCmdnJw3NDXi4uKvrq4zMDGGhIVNSkqnpqZfXV1VU1NFQkOurYy8AAAJQUlEQVR4nO2da3uqOhCFJVRaBKF4r5ZqrbX3\/f9\/3ol6rBdmYTKCYJ9ZX7ey83bW5EYyNhoikUgkEolEIpFIJBKJRCKRSCQSiUSEOrPRrFN1I8rU4l0p9b6ouhllabBIIt9xHD+JFoOqG1OCBgtnzbeSH\/npX2PsLN5\/+TaML38rjgs\/2edbMyZB+lf6nMGiHR3zbeLYXMRVN64ADb5eSL4No3P1jJ0U8\/2fj1ft1c7Cy+RfhtFLrrZfHSzC3Pjt+px2eo1eHSxof7bpfLw+xtSh+HxPTZVH\/UPid6tuso0Gi4jKP98L7+LGoJsdHDfwVxPH\/fnZYZjuNghxF3wguApGkH++F3Vvfz8UpwnpVT121L1f7aQubcHm3WHTO12XZPSa3TozxgsX+LObtd8AdEaJR3y4Horp\/HOS1p4\/D76Q6mGCYgxrmY9gfqa7yJyQxCkYO5zaeTVOwfgQ3OU3tQPHjlp5ddCFw\/jpZsYoH93aMA7Sl4RIJ0d3i3T+HStO22QctVfrwNhJkc3uzJuHTOAFleej7ipoPt+yaYOuU8d8jNOAXP\/5r4xmgbmc41WXjwPQJMcJhzPOA3WHjMaOKhgH9NTyf0T1M+M8tNNt0\/kYXTwf47SZvz\/RUs8jzoPRXM5LLhpHPYSd3H9x2uqbxRinITX4rPrVSzF26G6PYIx+mIxg7PBPTJCKEfrv3RbB2FJPLEbwR7zE2BF326SFEufjR9GM3DiCscOzmEgw\/lv0p\/VW87P7TxUSbWqr5z7rP0vBGtkvjXGAluXRNj3uH8g4ttUnr1\/tevR\/6JaSj3HXZDjuPwGv8vIRTCpWk16zSb254m6L7D+T8Dj171E+cr0K8tF04WImu2lx\/5P2avTEZIRjR1H5iPzptVA6QK8OmWNHQDfAZoGGFXebjPV7n\/ZqoHhxxHO5s\/Nx+eGT82u4f\/ar\/jMaH5lebdFzudbHkvO8rZA\/lclUfzREXuXFEewDNKMz3ul0FRgfDF\/bjn4U9TItUA8sRjSXU2zEJfE8s\/2zX42eASOzXyXHRz\/hGjXNOt9LbLejRygfn+45bVrN5TIPS1LOo7TGmT+\/zzlWALzaUv94Xk0zj2qPOQ9qkIQfrM559A28OmTE8fajOMKpm3lWM7pheX40R\/loybj88JqZx7hTTpu0brKEmtGdsuI4o\/ucllUcb2+aTaI3dW84LWoAQr2aV1NWHGfIqw+GjMupovgKJ1w9kcs4jyjGUA17p7+8vFGwPYUTaq960wnnkTOUj5+P+V+cTIn8K5NQPzUas+I4QfmY59XlNMF8ZRGuNifGrDhO5hH14FC9Aq8ux9CfxRHSK3wu44xuckDm42RKfthPdlOlAgjdjzf6FKybMOM4RnOAx+MPkvnnR97bx6555xM27xqdr5eI3iycM70K4rjvVeDP1cnbTuPuF70YQq2vd7AhymQcJzTjQ2\/7ATLQfvTytZoel0Co4\/hOrRhX+ThjMU5JhHDtVZCsvnr52iy\/yyBcMQY0Y\/TNiuOSDpOey8092p\/u13Z5Uw5hI8erzzMeI+1ValEZan\/uvlkaoY7jK\/DqnMU4mZKM2fip16\/95Wl5hJrx7QUxsjZEwZB3xOe8HS6\/yyTU0oyFevUEYxg5X8ffKZlQM76qgGgL9wX+cupRj9vwqfe37DdKJ9SMD6RXW8wX+Msh5Yp1\/r1R20MXIGw0HoFXOS\/wZ98gfsf5t9VFCDXjK8lo\/cJwhjaPKX9udCHCtVdpRos4gk1VvaCCfBckbHQeUT4avoTp04tilH9bXY6wAfPRyKtgwziMVGZ8ONRFCTXjAxg7Tmxsj+gXxkGuPze6MKFmHJKMQZ5XwUvGUP07yVcBYaPRQ3EEG9t94E\/1fmLjbaMKCHMY\/2UZwYEG3X8a8VVEqBn\/gbw62izs0y+I9ecM+Soj1Iz04a9APe02YMChG51\/xnwVEq4Pf+V6FfvTYHN\/pwoJNSPyqmYAh99avxtQpqqUUHuVPjQUKh\/MDT4t+SonXB+MorxKze94L4MrJ9SMtFezfKYvEA9VA0J4wG1f3ANENSGE48KO78k6\/7aqCWFuHAN2\/FaqDaFeP8DDmGfw1YpwNcfOvMBvMQ9+7VQrwvWhof045q6pDFUzwtVafofY+jybr4aEjXh35M4r4vRy\/Qhv9wiLOGcvhAYSQksJoa2E0EBCaCkhtJUQGkgILSWEthJCAwmhpYTQVkJoICG0lBDaSggNJISWEkJbCaGBhNBSQmgrITSQEFqq1oQO8+L2gYolXI53tcALucvdVrwL+HsqkvDwLlhBt9Xd5Mw4Fke4PCo\/UNh9fFedxVgUYfb6M5swW2PoLK8WQ7gk7g4n3N+qmxB1\/d2IdwG\/UQzhZEzVY4jYf\/apyj6NXRCjAEJwZ1hxC\/BozUG1zjmH8VxCcO87UHPGw371OASXYRn5eB4huLsfWB3vJwUuiTDy8RzC5Zi8nm9+\/SRXPfrCbzuyLBbBJ1yS\/Yvx9SEDPdIHti0LYnAJYf6ZX68x0COqgmxREINHCO7q212vMVKPvgzrmnuVQ0iPf6urKUXzrQQrPRsy2hMa1bApVNqrZJ9j5lVbwtzaLqWpR18UdU0Y7QiBP8Ni+xdK\/LHDhhCMD0Fx40OeYD6eKMJjTrik69bZX29jq0df2jqRj6aEM3r8C0\/W5StU93Q+aq\/O4HfMCEG9uuBy8duqb+1VE8IJqqt4cb6VeqC6PCqmdJoQlC9rlTs+5Oke5SPJeIoQ5F\/AuF5aoMClZnKek08Ix7\/S5i+mAhdFiYJReYQg\/\/Jrfl5M4BJlxquYEPqTf\/2yYPXRfPV7tvcpRDhD4wNRaqI6Qa\/uMdKEE7q2MPf6c4lCv0yyy0eKcELXhyZLhVQvnI+bQkNZwvrn37H6YC638eoxIfBnWM\/4bQWKsqy9ekgI\/Vm7\/DsW9mpvF9\/WPZqf1daf++r\/0F7df5OVFPM7ApUJ5GO+uL\/NUpFGw8ik6MdO55YfqEDgF58Q38+1+HNfBoVNtv4s4np+JQK\/+HQcv6vKv2MRBTGO+a6m\/0QChQO3\/jy\/PEYNBIq3nFueplbSjFmvXuH4kKeMV690fMjTaH985P7uWs012u51hMzfI7sCjR6U226qB1a57ytR\/2Z881fjJxKJRCKRSCQSiUQikUgkEolEIpHoTP0HQMK6qG8e9HsAAAAASUVORK5CYII=",
"imageable_id": 6,
"imageable_type": "item"
}
],
"identifiers": [
{
"id": 17,
"created_at": "2022-09-29T20:51:02.000000Z",
"updated_at": "2022-09-29T20:51:02.000000Z",
"item_id": 6,
"identifier": "B08W3QKXI8",
"identifier_type": "ASIN"
},
{
"id": 18,
"created_at": "2022-09-29T20:51:02.000000Z",
"updated_at": "2022-09-29T20:51:02.000000Z",
"item_id": 6,
"identifier": "X003ULKERY",
"identifier_type": "FNSKU"
},
{
"id": 78,
"created_at": "2022-09-29T20:51:02.000000Z",
"updated_at": "2022-09-29T20:51:02.000000Z",
"item_id": 6,
"identifier": "8993160747972",
"identifier_type": "EAN"
}
]
}
}
],
"customer": {
"id": 8,
"created_at": "2022-09-29T20:51:03.000000Z",
"updated_at": "2022-09-29T20:51:03.000000Z",
"name": "Gutkowski Inc",
"team_id": 1,
"channel_id": 1,
"default_address_id": 11,
"email": "fay.katherine@gmail.com",
"phone_number": "678-946-3287",
"email_hash": "c258b0c54db2cc493c4e18bdb7104bceb0112c51cedb9b9e7a670acfaaf0ea23",
"name_address_hash": "bec47517788fd87023ee1cb17be7dc00d5bc412ffcd90b85280531cee3b904d2"
},
"shipping_address": {
"id": 11,
"created_at": "2022-09-29T20:51:03.000000Z",
"updated_at": "2022-09-29T20:51:03.000000Z",
"addressable_type": "customer",
"addressable_id": 8,
"address_line_1": "1000 State Route 36",
"address_line_2": "Suite 395",
"address_line_3": null,
"city": "Hornell",
"state_province": "NY",
"country_code": "US",
"postal_code": "14843-7628",
"phone_number": null,
"is_residential": false
},
"packages": [
{
"id": 3,
"created_at": "2022-10-05T00:41:25.000000Z",
"updated_at": "2022-10-05T00:41:39.000000Z",
"order_id": 8,
"shipped_at": "2022-10-05T00:41:39.000000Z",
"arrived_at": null,
"lpn": "prcl_220ea47f6aa49d67cceca40f7de42ee1",
"hash": "pkg_Q5JymjnDxn8qoKl",
"box": {
"id": 375,
"created_at": "2022-10-05T00:41:25.000000Z",
"updated_at": "2022-10-05T00:41:25.000000Z",
"boxable_id": 3,
"boxable_type": "package",
"weight_gm": 2061,
"length_mm": 127,
"width_mm": 127,
"height_mm": 127
},
"attachments": [
{
"id": 5,
"created_at": "2022-10-05T00:41:39.000000Z",
"updated_at": "2022-10-05T00:41:39.000000Z",
"path": "attachments\/4JSoebFo49MyOmW4AWNMDcpoDq2GqMShsGrieKnvy6fRGPxM7mZFqvWK1mK49lFjyOsHCtqJPpppdIsCcGUosyUCr6kIUuSUxXJDLCm8Ow7KbNzTzxJfu4pM.pdf",
"name": "Shipping Label",
"url": "http:\/\/admin.prepbusiness.com\/storage\/attachments\/4JSoebFo49MyOmW4AWNMDcpoDq2GqMShsGrieKnvy6fRGPxM7mZFqvWK1mK49lFjyOsHCtqJPpppdIsCcGUosyUCr6kIUuSUxXJDLCm8Ow7KbNzTzxJfu4pM.pdf",
"attachable_id": 3,
"attachable_type": "package"
}
],
"package_items": [
{
"id": 4,
"created_at": "2022-10-05T00:41:25.000000Z",
"updated_at": "2022-10-05T00:41:25.000000Z",
"order_item_id": 8,
"package_id": 3,
"quantity": 1,
"tote_barcode": null,
"packed_at": null,
"packed_by_user_id": null,
"lot_code": null
}
]
}
],
"attachments": [
{
"id": 6,
"created_at": "2022-10-05T00:41:39.000000Z",
"updated_at": "2022-10-05T00:41:39.000000Z",
"path": "attachments\/wZC2fpvZTE8Mb0jqmYnw5xVSZsktoqEL0HCBkYJKPTmEQTRbFtCnVppYSvo8kg4D35AvAm8s7d3jiFOQpUrzj8VMpiSUpKLUdDeNbsMrgmPHYHEpnWHOv3JH.pdf",
"name": "Shipping Label",
"url": "http:\/\/admin.prepbusiness.com\/storage\/attachments\/wZC2fpvZTE8Mb0jqmYnw5xVSZsktoqEL0HCBkYJKPTmEQTRbFtCnVppYSvo8kg4D35AvAm8s7d3jiFOQpUrzj8VMpiSUpKLUdDeNbsMrgmPHYHEpnWHOv3JH.pdf",
"attachable_id": 8,
"attachable_type": "order"
},
{
"id": 7,
"created_at": "2022-10-05T00:41:41.000000Z",
"updated_at": "2022-10-05T00:41:41.000000Z",
"path": "attachments\/CjWRncHiqBqpqLeLZfns5YzCMJI9ZObdupgXFhkO5cuUTW9uVQmSMv5wti4an1SfXzFmb8bpy7ESVR2NqlbKGZloNx3OLaw8lpY8xnzdnOeGTMaVuUpO0ymB.pdf",
"name": "Batch Shipping Labels",
"url": "http:\/\/admin.prepbusiness.com\/storage\/attachments\/CjWRncHiqBqpqLeLZfns5YzCMJI9ZObdupgXFhkO5cuUTW9uVQmSMv5wti4an1SfXzFmb8bpy7ESVR2NqlbKGZloNx3OLaw8lpY8xnzdnOeGTMaVuUpO0ymB.pdf",
"attachable_id": 8,
"attachable_type": "order"
}
]
}
}Upload Shipping Label
Add a shipping label to an order. This will not add a tracking number to the order and mark it as shipped. This must be done in a separate call.
POST
/orders/{ORDER_ID}/uploadShippingLabel
| Parameter | Type | Examples | Description |
|---|---|---|---|
file
| file | Shipping Label.pdf | A file containing the shipping labels for the order. The file can be a PDF, PNG, or JPG. |
Example Response
{}Mark as Shipped
Mark an order as shipped and add a tracking number. This will send the tracking number to the marketplace and mark the order as shipped there.
POST
/orders/{ORDER_ID}/markAsShipped
| Parameter | Type | Examples | Description |
|---|---|---|---|
carrier
| string | fedex | The carrier that was used to ship the order. Valid values: fedex, ups, usps, shippo, canada_post, dhl_express, ontrac, other |
tracking_number
| string | 1Z12345E0291980793 | The tracking number for the shipment. This is required if the carrier is set. |
Example Response
{
"message": "Order marked as shipped"
}