{"info":{"_postman_id":"c7220508-1f65-4601-a2a5-382e970e6d23","name":"Awp Retailer API","description":"

Description

This API is designed to synchronize a retailer's online customer transactions with the AllureBridals ecosystem and request the status of a transaction. Additionally, the related retailer has to log in using a Basic Auth user password strategy to have access.

All endpoints have validation responses for different situations to guide the user during the request process.

Good to know

The data used in the request body in the endpoint request is to explain how it works only, it doesn't have any relation with real data and its use in the API can lead to possible errors.

Status and error code

Here are short explanations for the specified HTTP status codes, separated into title and description:

`200 OK`

The request has succeeded. The information returned with the response is dependent on the method used in the request, such as GET, POST, PUT, or DELETE.

`201 Created`

The request has been fulfilled, resulting in the creation of a new resource. The response typically includes a Location header field containing the address of the new resource.

`400 Bad Request`

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

`401 Unauthorized`

The request requires user authentication. The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource.

`404 Not Found`

The server cannot find the requested resource. This status code is commonly returned when the server does not wish to reveal whether it has the requested information.

`500 Internal Server Error`

The server encountered an unexpected condition that prevented it from fulfilling the request. This generic error message is given when no more specific message is suitable.

Retailer authentication

All API queries require a valid username and password, like the following example. You will receive your unique values once you have confirmed with Allure Bridals that your e-commerce site is eligible for integration.

export async function getTransactionStatus(\n  retailerId: string,\n  orderId: string,\n) {\n  const URL = `${BASE_PATH}/retailers/${retailerId}/orders/${orderId}`;\n  const headers = new Headers();\n  headers.set(\n    'Authorization',\n    'Basic ' + nextBase64.encode(RETAILER_USERNAME + ':' + RETAILER_PASSWORD),\n  );\n  const response = await fetch(URL, {\n    headers,\n  });\n  const data = await response.json();\n  return data;\n}\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"29967774","collectionId":"c7220508-1f65-4601-a2a5-382e970e6d23","publishedId":"2sA3e5cT8b","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-12T18:04:24.000Z"},"item":[{"name":"Retailer sync orders","id":"9df4ce58-aec3-4520-b3cc-392798a06107","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"retailerCode\": \"MOCK01\",\n \"data\": [\n {\n \"order_id\": \"1234567\",\n \"customer_id\": \"202\",\n \"name\": \"Alex Johnson\",\n \"email\": \"alex@example.com\",\n \"phone\": \"(123)456-7890\",\n \"order_date\": \"01-01-2022\",\n \"ship_method\": \"UPS (Ground)\",\n \"order_currency_code\": \"EUR\",\n \"order_notes\": \"No special instructions\",\n \"external_document_number\": \"SO12345\",\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"1234 Elm Street\",\n \"address_2\": \"Apt 567\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"john@example.com\"\n },\n \"shipping_address\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"5678 Oak Street\",\n \"address_2\": \"Suite 890\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"jane@example.com\"\n },\n \"lines\": [\n {\n \"special_order\": false,\n \"shipping_window\": \"Express\",\n \"wear_date\": \"12/25/2022\",\n \"quantity\": 2,\n \"sku\": \"MOCKSKU-01\",\n \"size\": \"Large\",\n \"color\": \"Red/White\",\n \"length\": \"Long\",\n \"customizations\": {\n \"hollow_to_hem\": false,\n \"color_change\": true,\n \"fabric_change\": true,\n \"add_remove_buttons\": false,\n \"modify_neckline\": true,\n \"extend_reduce_sleeves\": true,\n \"remove_beading_embroidery\": false,\n \"reduce_train_length\": true,\n \"extend_train_length\": true,\n \"change_to_zipper_laceup_back\": false\n },\n \"order_class\": \"Express\",\n \"ship_date\": \"12/01/2022\",\n \"product_unit_price\": \"999\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-api-awp.azurewebsites.net/retailers","description":"

Description

The POST /retailers endpoint is used to submit the customer orders to the AllureBridals ecosystem to process them.

There are validations in place for every field in the request body. They will help act as a guide to ensure that all required fields are filled out in their respective formats.

Four types of answers (status code) come from the endpoint, 200, 400, 404, and 500. You can find the related documentation lines below.

Limitations

The endpoint is limited to 10 products per transaction to optimize the response speed. If there is a need to submit more products, repeat the request with the same data and new products in the array of products.

Request Schema

{\n  \"retailerCode\": {\n    \"type\": \"string\",\n    \"description\": \"The code of the retailer\"\n  },\n  \"data\": {\n    \"type\": \"array\",\n    \"description\": \"An array of orders\",\n    \"items\": {\n      \"type\": \"object\",\n      \"description\": \"Order details\",\n      \"properties\": {\n        \"order_id\": {\n          \"type\": \"string\",\n          \"description\": \"The ID of the order\"\n        },\n        \"customer_id\": {\n          \"type\": \"string\",\n          \"description\": \"The ID of the customer\"\n        },\n        \"name\": {\n          \"type\": \"string\",\n          \"description\": \"The name of the customer\"\n        },\n        \"email\": {\n          \"type\": \"string\",\n          \"description\": \"The email of the customer\"\n        },\n        \"phone\": {\n          \"type\": \"string\",\n          \"description\": \"The phone number of the customer\"\n        },\n        \"order_date\": {\n          \"type\": \"string\",\n          \"description\": \"The date of the order\"\n        },\n        \"ship_method\": {\n          \"type\": \"string\",\n          \"description\": \"The shipping method for the order\"\n        },\n        \"order_currency_code\": {\n          \"type\": \"string\",\n          \"description\": \"The currency code of the order\"\n        },\n        \"order_notes\": {\n          \"type\": \"string\",\n          \"description\": \"Any additional notes for the order\"\n        },\n        \"external_document_number\": {\n          \"type\": \"string\",\n          \"description\": \"The external document number for the order\"\n        },\n        \"billing_address\": {\n          \"type\": \"object\",\n          \"description\": \"The billing address details\",\n          \"properties\": {\n            \"first_name\": {\n              \"type\": \"string\",\n              \"description\": \"The first name in the billing address\"\n            },\n            \"last_name\": {\n              \"type\": \"string\",\n              \"description\": \"The last name in the billing address\"\n            },\n            \"company\": {\n              \"type\": \"string\",\n              \"description\": \"The company name in the billing address\"\n            },\n            \"address_1\": {\n              \"type\": \"string\",\n              \"description\": \"The first line of the billing address\"\n            },\n            \"address_2\": {\n              \"type\": \"string\",\n              \"description\": \"The second line of the billing address\"\n            },\n            \"city\": {\n              \"type\": \"string\",\n              \"description\": \"The city in the billing address\"\n            },\n            \"state\": {\n              \"type\": \"string\",\n              \"description\": \"The state in the billing address\"\n            },\n            \"zip\": {\n              \"type\": \"string\",\n              \"description\": \"The zip code in the billing address\"\n            },\n            \"country\": {\n              \"type\": \"string\",\n              \"description\": \"The country in the billing address\"\n            },\n            \"phone\": {\n              \"type\": \"string\",\n              \"description\": \"The phone number in the billing address\"\n            },\n            \"email\": {\n              \"type\": \"string\",\n              \"description\": \"The email in the billing address\"\n            }\n          }\n        },\n        \"shipping_address\": {\n          \"type\": \"object\",\n          \"description\": \"The shipping address details\",\n          \"properties\": {\n            \"first_name\": {\n              \"type\": \"string\",\n              \"description\": \"The first name in the shipping address\"\n            },\n            \"last_name\": {\n              \"type\": \"string\",\n              \"description\": \"The last name in the shipping address\"\n            },\n            \"company\": {\n              \"type\": \"string\",\n              \"description\": \"The company name in the shipping address\"\n            },\n            \"address_1\": {\n              \"type\": \"string\",\n              \"description\": \"The first line of the shipping address\"\n            },\n            \"address_2\": {\n              \"type\": \"string\",\n              \"description\": \"The second line of the shipping address\"\n            },\n            \"city\": {\n              \"type\": \"string\",\n              \"description\": \"The city in the shipping address\"\n            },\n            \"state\": {\n              \"type\": \"string\",\n              \"description\": \"The state in the shipping address\"\n            },\n            \"zip\": {\n              \"type\": \"string\",\n              \"description\": \"The zip code in the shipping address\"\n            },\n            \"country\": {\n              \"type\": \"string\",\n              \"description\": \"The country in the shipping address\"\n            },\n            \"phone\": {\n              \"type\": \"string\",\n              \"description\": \"The phone number in the shipping address\"\n            },\n            \"email\": {\n              \"type\": \"string\",\n              \"description\": \"The email in the shipping address\"\n            }\n          }\n        },\n        \"lines\": {\n          \"type\": \"array\",\n          \"description\": \"An array of product\",\n          \"items\": {\n            \"type\": \"object\",\n            \"description\": \"Product line details\",\n            \"properties\": {\n              \"special_order\": {\n                \"type\": \"boolean\",\n                \"description\": \"Indicates if the order is a special order\"\n              },\n              \"shipping_window\": {\n                \"type\": \"string\",\n                \"description\": \"The shipping window for the product\"\n              },\n              \"wear_date\": {\n                \"type\": \"string\",\n                \"description\": \"The wear date for the product\"\n              },\n              \"quantity\": {\n                \"type\": \"number\",\n                \"description\": \"The quantity of the product\"\n              },\n              \"sku\": {\n                \"type\": \"string\",\n                \"description\": \"The SKU of the product\"\n              },\n              \"size\": {\n                \"type\": \"string\",\n                \"description\": \"The size of the product\"\n              },\n              \"color\": {\n                \"type\": \"string\",\n                \"description\": \"The color of the product\"\n              },\n              \"length\": {\n                \"type\": \"string\",\n                \"description\": \"The length of the product\"\n              },\n              \"customizations\": {\n                \"type\": \"object\",\n                \"description\": \"Customizations for the product line\",\n                \"properties\": {\n                  \"hollow_to_hem\": {\n                    \"type\": \"boolean\",\n                    \"description\": \"Indicates if there is a hollow to hem customization\"\n                  },\n                  \"color_change\": {\n                    \"type\": \"boolean\",\n                    \"description\": \"Indicates if there is a color change customization\"\n                  },\n                  \"fabric_change\": {\n                    \"type\": \"boolean\",\n                    \"description\": \"Indicates if there is a fabric change customization\"\n                  },\n                  \"add_remove_buttons\": {\n                    \"type\": \"boolean\",\n                    \"description\": \"Indicates if there is an add/remove buttons customization\"\n                  },\n                  \"modify_neckline\": {\n                    \"type\": \"boolean\",\n                    \"description\": \"Indicates if there is a modify neckline customization\"\n                  },\n                  \"extend_reduce_sleeves\": {\n                    \"type\": \"boolean\",\n                    \"description\": \"Indicates if there is an extend/reduce sleeves customization\"\n                  },\n                  \"remove_beading_embroidery\": {\n                    \"type\": \"boolean\",\n                    \"description\": \"Indicates if there is a remove beading/embroidery customization\"\n                  },\n                  \"reduce_train_length\": {\n                    \"type\": \"boolean\",\n                    \"description\": \"Indicates if there is a reduce train length customization\"\n                  },\n                  \"extend_train_length\": {\n                    \"type\": \"boolean\",\n                    \"description\": \"Indicates if there is an extend train length customization\"\n                  },\n                  \"change_to_zipper_laceup_back\": {\n                    \"type\": \"boolean\",\n                    \"description\": \"Indicates if there is a change to zipper/lace-up back customization\"\n                  }\n                }\n              },\n              \"order_class\": {\n                \"type\": \"string\",\n                \"description\": \"The class of the order\"\n              },\n              \"ship_date\": {\n                \"type\": \"string\",\n                \"description\": \"The shipping date for the product line\"\n              },\n              \"product_unit_price\": {\n                \"type\": \"string\",\n                \"description\": \"The unit price of the product\"\n              }\n            }\n          }\n        }\n      }\n    }\n  }\n}\n\n

Response Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"status\": {\n      \"type\": \"number\"\n    },\n    \"message\": {\n      \"type\": \"string\"\n    },\n    \"data\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"order_ids\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\"\n          }\n        },\n        \"total_orders\": {\n          \"type\": \"number\"\n        },\n        \"order_status\": {\n          \"type\": \"string\"\n        }\n      }\n    }\n  }\n}\n\n

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"c7220508-1f65-4601-a2a5-382e970e6d23","id":"c7220508-1f65-4601-a2a5-382e970e6d23","name":"Awp Retailer API","type":"collection"}},"urlObject":{"path":["retailers"],"host":["https://stage-api-awp.azurewebsites.net"],"query":[],"variable":[]}},"response":[{"id":"42183810-072e-46cb-8de5-dc5dda8284e7","name":"200 - order successfully created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"retailerCode\": \"MOCK01\",\n \"data\": [\n {\n \"order_id\": \"1234567\",\n \"customer_id\": \"202\",\n \"name\": \"Alex Johnson\",\n \"email\": \"alex@example.com\",\n \"phone\": \"(123)456-7890\",\n \"order_date\": \"01-01-2022\",\n \"ship_method\": \"UPS (Ground)\",\n \"order_currency_code\": \"EUR\",\n \"order_notes\": \"No special instructions\",\n \"external_document_number\": \"SO12345\",\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"1234 Elm Street\",\n \"address_2\": \"Apt 567\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"john@example.com\"\n },\n \"shipping_address\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"5678 Oak Street\",\n \"address_2\": \"Suite 890\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"jane@example.com\"\n },\n \"lines\": [\n {\n \"special_order\": false,\n \"shipping_window\": \"Express\",\n \"wear_date\": \"12/25/2022\",\n \"quantity\": 2,\n \"sku\": \"MOCKSKU-01\",\n \"size\": \"Large\",\n \"color\": \"Red/White\",\n \"length\": \"Long\",\n \"customizations\": {\n \"hollow_to_hem\": false,\n \"color_change\": true,\n \"fabric_change\": true,\n \"add_remove_buttons\": false,\n \"modify_neckline\": true,\n \"extend_reduce_sleeves\": true,\n \"remove_beading_embroidery\": false,\n \"reduce_train_length\": true,\n \"extend_train_length\": true,\n \"change_to_zipper_laceup_back\": false\n },\n \"order_class\": \"Express\",\n \"ship_date\": \"12/01/2022\",\n \"product_unit_price\": \"999\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-api-awp.azurewebsites.net/retailers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"message\": \"Order has been successfully created\",\n \"data\": {\n \"order_ids\": [\n \"1234567\"\n ],\n \"total_orders\": 1,\n \"order_status\": \"Pending\"\n }\n}"},{"id":"10cdc9ae-0eb8-43be-bb13-ff3de420b829","name":"400 - products belong to different collection","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"retailerCode\": \"MOCK01\",\n \"data\": [\n {\n \"order_id\": \"1234567\",\n \"customer_id\": \"202\",\n \"name\": \"Alex Johnson\",\n \"email\": \"alex@example.com\",\n \"phone\": \"(123)456-7890\",\n \"order_date\": \"01-01-2022\",\n \"ship_method\": \"UPS (Ground)\",\n \"order_currency_code\": \"EUR\",\n \"order_notes\": \"No special instructions\",\n \"external_document_number\": \"SO12345\",\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"1234 Elm Street\",\n \"address_2\": \"Apt 567\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"john@example.com\"\n },\n \"shipping_address\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"5678 Oak Street\",\n \"address_2\": \"Suite 890\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"jane@example.com\"\n },\n \"lines\": [\n {\n \"special_order\": false,\n \"shipping_window\": \"Express\",\n \"wear_date\": \"12/25/2022\",\n \"quantity\": 2,\n \"sku\": \"MOCKSKU-01\",\n \"size\": \"Large\",\n \"color\": \"Red/White\",\n \"length\": \"Long\",\n \"customizations\": {\n \"hollow_to_hem\": false,\n \"color_change\": true,\n \"fabric_change\": true,\n \"add_remove_buttons\": false,\n \"modify_neckline\": true,\n \"extend_reduce_sleeves\": true,\n \"remove_beading_embroidery\": false,\n \"reduce_train_length\": true,\n \"extend_train_length\": true,\n \"change_to_zipper_laceup_back\": false\n },\n \"order_class\": \"Express\",\n \"ship_date\": \"12/01/2022\",\n \"product_unit_price\": \"999\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-api-awp.azurewebsites.net/retailers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 400,\n \"message\": \"One or more products belong to a different collection than expected.\"\n}"},{"id":"a7a183d5-43b6-437a-a06a-0aee51a566e3","name":"400 - order must contain at least 1 element","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"retailerCode\": \"MOCK01\",\n \"data\": [\n {\n \"order_id\": \"1234567\",\n \"customer_id\": \"202\",\n \"name\": \"Alex Johnson\",\n \"email\": \"alex@example.com\",\n \"phone\": \"(123)456-7890\",\n \"order_date\": \"01-01-2022\",\n \"ship_method\": \"UPS (Ground)\",\n \"order_currency_code\": \"EUR\",\n \"order_notes\": \"No special instructions\",\n \"external_document_number\": \"SO12345\",\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"1234 Elm Street\",\n \"address_2\": \"Apt 567\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"john@example.com\"\n },\n \"shipping_address\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"5678 Oak Street\",\n \"address_2\": \"Suite 890\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"jane@example.com\"\n },\n \"lines\": [\n {\n \"special_order\": false,\n \"shipping_window\": \"Express\",\n \"wear_date\": \"12/25/2022\",\n \"quantity\": 2,\n \"sku\": \"MOCKSKU-01\",\n \"size\": \"Large\",\n \"color\": \"Red/White\",\n \"length\": \"Long\",\n \"customizations\": {\n \"hollow_to_hem\": false,\n \"color_change\": true,\n \"fabric_change\": true,\n \"add_remove_buttons\": false,\n \"modify_neckline\": true,\n \"extend_reduce_sleeves\": true,\n \"remove_beading_embroidery\": false,\n \"reduce_train_length\": true,\n \"extend_train_length\": true,\n \"change_to_zipper_laceup_back\": false\n },\n \"order_class\": \"Express\",\n \"ship_date\": \"12/01/2022\",\n \"product_unit_price\": \"999\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-api-awp.azurewebsites.net/retailers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n \"data.0.lines must contain at least 1 elements\"\n ],\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"},{"id":"e617c35a-7346-47c4-a6a9-ee1533ad8b15","name":"404 - retailer not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"retailerCode\": \"MOCK01\",\n \"data\": [\n {\n \"order_id\": \"1234567\",\n \"customer_id\": \"202\",\n \"name\": \"Alex Johnson\",\n \"email\": \"alex@example.com\",\n \"phone\": \"(123)456-7890\",\n \"order_date\": \"01-01-2022\",\n \"ship_method\": \"UPS (Ground)\",\n \"order_currency_code\": \"EUR\",\n \"order_notes\": \"No special instructions\",\n \"external_document_number\": \"SO12345\",\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"1234 Elm Street\",\n \"address_2\": \"Apt 567\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"john@example.com\"\n },\n \"shipping_address\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"5678 Oak Street\",\n \"address_2\": \"Suite 890\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"jane@example.com\"\n },\n \"lines\": [\n {\n \"special_order\": false,\n \"shipping_window\": \"Express\",\n \"wear_date\": \"12/25/2022\",\n \"quantity\": 2,\n \"sku\": \"MOCKSKU-01\",\n \"size\": \"Large\",\n \"color\": \"Red/White\",\n \"length\": \"Long\",\n \"customizations\": {\n \"hollow_to_hem\": false,\n \"color_change\": true,\n \"fabric_change\": true,\n \"add_remove_buttons\": false,\n \"modify_neckline\": true,\n \"extend_reduce_sleeves\": true,\n \"remove_beading_embroidery\": false,\n \"reduce_train_length\": true,\n \"extend_train_length\": true,\n \"change_to_zipper_laceup_back\": false\n },\n \"order_class\": \"Express\",\n \"ship_date\": \"12/01/2022\",\n \"product_unit_price\": \"999\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-api-awp.azurewebsites.net/retailers"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"message\": \"Retailer not found.\",\n \"originalError\": \"Could not find any entity of type \\\"Retailer\\\" matching: {\\n \\\"retailerID\\\": \\\"HAP009\\\"\\n}\"\n}"},{"id":"69cae6a1-d611-4538-99e7-0e69b28855be","name":"400 - more that 10 elements","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"retailerCode\": \"MOCK01\",\n \"data\": [\n {\n \"order_id\": \"1234567\",\n \"customer_id\": \"202\",\n \"name\": \"Alex Johnson\",\n \"email\": \"alex@example.com\",\n \"phone\": \"(123)456-7890\",\n \"order_date\": \"01-01-2022\",\n \"ship_method\": \"UPS (Ground)\",\n \"order_currency_code\": \"EUR\",\n \"order_notes\": \"No special instructions\",\n \"external_document_number\": \"SO12345\",\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"1234 Elm Street\",\n \"address_2\": \"Apt 567\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"john@example.com\"\n },\n \"shipping_address\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"5678 Oak Street\",\n \"address_2\": \"Suite 890\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"jane@example.com\"\n },\n \"lines\": [\n {\n \"special_order\": false,\n \"shipping_window\": \"Express\",\n \"wear_date\": \"12/25/2022\",\n \"quantity\": 2,\n \"sku\": \"MOCKSKU-01\",\n \"size\": \"Large\",\n \"color\": \"Red/White\",\n \"length\": \"Long\",\n \"customizations\": {\n \"hollow_to_hem\": false,\n \"color_change\": true,\n \"fabric_change\": true,\n \"add_remove_buttons\": false,\n \"modify_neckline\": true,\n \"extend_reduce_sleeves\": true,\n \"remove_beading_embroidery\": false,\n \"reduce_train_length\": true,\n \"extend_train_length\": true,\n \"change_to_zipper_laceup_back\": false\n },\n \"order_class\": \"Express\",\n \"ship_date\": \"12/01/2022\",\n \"product_unit_price\": \"999\"\n },\n {\n \"special_order\": false,\n \"shipping_window\": \"Express\",\n \"wear_date\": \"12/25/2022\",\n \"quantity\": 2,\n \"sku\": \"MOCKSKU-01\",\n \"size\": \"Large\",\n \"color\": \"Red/White\",\n \"length\": \"Long\",\n \"customizations\": {\n \"hollow_to_hem\": false,\n \"color_change\": true,\n \"fabric_change\": true,\n \"add_remove_buttons\": false,\n \"modify_neckline\": true,\n \"extend_reduce_sleeves\": true,\n \"remove_beading_embroidery\": false,\n \"reduce_train_length\": true,\n \"extend_train_length\": true,\n \"change_to_zipper_laceup_back\": false\n },\n \"order_class\": \"Express\",\n \"ship_date\": \"12/01/2022\",\n \"product_unit_price\": \"999\"\n },\n {\n \"special_order\": true,\n \"shipping_window\": \"Standard\",\n \"wear_date\": \"01/10/2023\",\n \"quantity\": 1,\n \"sku\": \"MOCKSKU-02\",\n \"size\": \"Medium\",\n \"color\": \"Blue/Green\",\n \"length\": \"Short\",\n \"customizations\": {\n \"hollow_to_hem\": true,\n \"color_change\": false,\n \"fabric_change\": false,\n \"add_remove_buttons\": true,\n \"modify_neckline\": false,\n \"extend_reduce_sleeves\": false,\n \"remove_beading_embroidery\": true,\n \"reduce_train_length\": false,\n \"extend_train_length\": false,\n \"change_to_zipper_laceup_back\": true\n },\n \"order_class\": \"Standard\",\n \"ship_date\": \"12/15/2022\",\n \"product_unit_price\": \"499\"\n },\n {\n \"special_order\": false,\n \"shipping_window\": \"Overnight\",\n \"wear_date\": \"11/30/2022\",\n \"quantity\": 3,\n \"sku\": \"MOCKSKU-03\",\n \"size\": \"Small\",\n \"color\": \"Black/White\",\n \"length\": \"Medium\",\n \"customizations\": {\n \"hollow_to_hem\": false,\n \"color_change\": false,\n \"fabric_change\": true,\n \"add_remove_buttons\": false,\n \"modify_neckline\": true,\n \"extend_reduce_sleeves\": false,\n \"remove_beading_embroidery\": false,\n \"reduce_train_length\": true,\n \"extend_train_length\": true,\n \"change_to_zipper_laceup_back\": false\n },\n \"order_class\": \"Overnight\",\n \"ship_date\": \"11/20/2022\",\n \"product_unit_price\": \"1299\"\n },\n {\n \"special_order\": true,\n \"shipping_window\": \"Standard\",\n \"wear_date\": \"02/15/2023\",\n \"quantity\": 4,\n \"sku\": \"MOCKSKU-04\",\n \"size\": \"Extra Large\",\n \"color\": \"Green/Yellow\",\n \"length\": \"Long\",\n \"customizations\": {\n \"hollow_to_hem\": true,\n \"color_change\": true,\n \"fabric_change\": false,\n \"add_remove_buttons\": true,\n \"modify_neckline\": false,\n \"extend_reduce_sleeves\": true,\n \"remove_beading_embroidery\": false,\n \"reduce_train_length\": false,\n \"extend_train_length\": true,\n \"change_to_zipper_laceup_back\": true\n },\n \"order_class\": \"Standard\",\n \"ship_date\": \"01/25/2023\",\n \"product_unit_price\": \"899\"\n },\n {\n \"special_order\": false,\n \"shipping_window\": \"Express\",\n \"wear_date\": \"03/01/2023\",\n \"quantity\": 5,\n \"sku\": \"MOCKSKU-05\",\n \"size\": \"Small\",\n \"color\": \"White\",\n \"length\": \"Short\",\n \"customizations\": {\n \"hollow_to_hem\": false,\n \"color_change\": true,\n \"fabric_change\": true,\n \"add_remove_buttons\": false,\n \"modify_neckline\": true,\n \"extend_reduce_sleeves\": false,\n \"remove_beading_embroidery\": true,\n \"reduce_train_length\": true,\n \"extend_train_length\": false,\n \"change_to_zipper_laceup_back\": true\n },\n \"order_class\": \"Express\",\n \"ship_date\": \"02/15/2023\",\n \"product_unit_price\": \"799\"\n },\n {\n \"special_order\": true,\n \"shipping_window\": \"Overnight\",\n \"wear_date\": \"04/10/2023\",\n \"quantity\": 2,\n \"sku\": \"MOCKSKU-06\",\n \"size\": \"Medium\",\n \"color\": \"Black\",\n \"length\": \"Long\",\n \"customizations\": {\n \"hollow_to_hem\": true,\n \"color_change\": true,\n \"fabric_change\": false,\n \"add_remove_buttons\": true,\n \"modify_neckline\": false,\n \"extend_reduce_sleeves\": true,\n \"remove_beading_embroidery\": false,\n \"reduce_train_length\": false,\n \"extend_train_length\": true,\n \"change_to_zipper_laceup_back\": true\n },\n \"order_class\": \"Overnight\",\n \"ship_date\": \"03/25/2023\",\n \"product_unit_price\": \"1499\"\n },\n {\n \"special_order\": false,\n \"shipping_window\": \"Standard\",\n \"wear_date\": \"05/05/2023\",\n \"quantity\": 3,\n \"sku\": \"MOCKSKU-07\",\n \"size\": \"Large\",\n \"color\": \"Pink\",\n \"length\": \"Medium\",\n \"customizations\": {\n \"hollow_to_hem\": false,\n \"color_change\": true,\n \"fabric_change\": true,\n \"add_remove_buttons\": false,\n \"modify_neckline\": true,\n \"extend_reduce_sleeves\": false,\n \"remove_beading_embroidery\": true,\n \"reduce_train_length\": true,\n \"extend_train_length\": false,\n \"change_to_zipper_laceup_back\": false\n },\n \"order_class\": \"Standard\",\n \"ship_date\": \"04/15/2023\",\n \"product_unit_price\": \"599\"\n },\n {\n \"special_order\": true,\n \"shipping_window\": \"Express\",\n \"wear_date\": \"06/01/2023\",\n \"quantity\": 1,\n \"sku\": \"MOCKSKU-08\",\n \"size\": \"Extra Small\",\n \"color\": \"Red\",\n \"length\": \"Long\",\n \"customizations\": {\n \"hollow_to_hem\": true,\n \"color_change\": true,\n \"fabric_change\": true,\n \"add_remove_buttons\": true,\n \"modify_neckline\": true,\n \"extend_reduce_sleeves\": true,\n \"remove_beading_embroidery\": true,\n \"reduce_train_length\": true,\n \"extend_train_length\": true,\n \"change_to_zipper_laceup_back\": true\n },\n \"order_class\": \"Express\",\n \"ship_date\": \"05/20/2023\",\n \"product_unit_price\": \"999\"\n },\n {\n \"special_order\": false,\n \"shipping_window\": \"Overnight\",\n \"wear_date\": \"07/15/2023\",\n \"quantity\": 4,\n \"sku\": \"MOCKSKU-09\",\n \"size\": \"Medium\",\n \"color\": \"Purple\",\n \"length\": \"Short\",\n \"customizations\": {\n \"hollow_to_hem\": false,\n \"color_change\": false,\n \"fabric_change\": true,\n \"add_remove_buttons\": false,\n \"modify_neckline\": false,\n \"extend_reduce_sleeves\": true,\n \"remove_beading_embroidery\": true,\n \"reduce_train_length\": true,\n \"extend_train_length\": false,\n \"change_to_zipper_laceup_back\": false\n },\n \"order_class\": \"Overnight\",\n \"ship_date\": \"07/01/2023\",\n \"product_unit_price\": \"1299\"\n },\n {\n \"special_order\": true,\n \"shipping_window\": \"Standard\",\n \"wear_date\": \"08/20/2023\",\n \"quantity\": 2,\n \"sku\": \"MOCKSKU-10\",\n \"size\": \"Large\",\n \"color\": \"Yellow\",\n \"length\": \"Medium\",\n \"customizations\": {\n \"hollow_to_hem\": true,\n \"color_change\": true,\n \"fabric_change\": false,\n \"add_remove_buttons\": true,\n \"modify_neckline\": true,\n \"extend_reduce_sleeves\": false,\n \"remove_beading_embroidery\": false,\n \"reduce_train_length\": true,\n \"extend_train_length\": true,\n \"change_to_zipper_laceup_back\": true\n },\n \"order_class\": \"Standard\",\n \"ship_date\": \"08/05/2023\",\n \"product_unit_price\": \"699\"\n },\n {\n \"special_order\": false,\n \"shipping_window\": \"Express\",\n \"wear_date\": \"09/01/2023\",\n \"quantity\": 3,\n \"sku\": \"MOCKSKU-11\",\n \"size\": \"Small\",\n \"color\": \"Orange\",\n \"length\": \"Long\",\n \"customizations\": {\n \"hollow_to_hem\": false,\n \"color_change\": true,\n \"fabric_change\": true,\n \"add_remove_buttons\": false,\n \"modify_neckline\": false,\n \"extend_reduce_sleeves\": true,\n \"remove_beading_embroidery\": true,\n \"reduce_train_length\": true,\n \"extend_train_length\": false,\n \"change_to_zipper_laceup_back\": true\n },\n \"order_class\": \"Express\",\n \"ship_date\": \"08/15/2023\",\n \"product_unit_price\": \"1099\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-api-awp.azurewebsites.net/retailers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n \"data.0.lines must contain no more than 10 elements\"\n ],\n \"error\": \"Bad Request\",\n \"statusCode\": 400\n}"},{"id":"a5fb2f4b-b3c0-4b3b-a75a-970eceef4675","name":"500 - Failed to sync retailer data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"retailerCode\": \"MOCK01\",\n \"data\": [\n {\n \"order_id\": \"1234567\",\n \"customer_id\": \"202\",\n \"name\": \"Alex Johnson\",\n \"email\": \"alex@example.com\",\n \"phone\": \"(123)456-7890\",\n \"order_date\": \"01-01-2022\",\n \"ship_method\": \"UPS (Ground)\",\n \"order_currency_code\": \"EUR\",\n \"order_notes\": \"No special instructions\",\n \"external_document_number\": \"SO12345\",\n \"billing_address\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"1234 Elm Street\",\n \"address_2\": \"Apt 567\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"john@example.com\"\n },\n \"shipping_address\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"company\": \"Mocked Company\",\n \"address_1\": \"5678 Oak Street\",\n \"address_2\": \"Suite 890\",\n \"city\": \"Faketown\",\n \"state\": \"CA\",\n \"zip\": \"90210\",\n \"country\": \"Mockland\",\n \"phone\": \"(123)456-7890\",\n \"email\": \"jane@example.com\"\n },\n \"lines\": [\n {\n \"special_order\": false,\n \"shipping_window\": \"Express\",\n \"wear_date\": \"12/25/2022\",\n \"quantity\": 2,\n \"sku\": \"MOCKSKU-01\",\n \"size\": \"Large\",\n \"color\": \"Red/White\",\n \"length\": \"Long\",\n \"customizations\": {\n \"hollow_to_hem\": false,\n \"color_change\": true,\n \"fabric_change\": true,\n \"add_remove_buttons\": false,\n \"modify_neckline\": true,\n \"extend_reduce_sleeves\": true,\n \"remove_beading_embroidery\": false,\n \"reduce_train_length\": true,\n \"extend_train_length\": true,\n \"change_to_zipper_laceup_back\": false\n },\n \"order_class\": \"Express\",\n \"ship_date\": \"12/01/2022\",\n \"product_unit_price\": \"999\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://stage-api-awp.azurewebsites.net/retailers"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"message\": \"Failed to sync retailer data\",\n \"originalError\": \"Original Error message\"\n}"}],"_postman_id":"9df4ce58-aec3-4520-b3cc-392798a06107"},{"name":"Retailer order status","id":"165f2d4b-5c08-4330-81d2-5c91417efb8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://stage-api-awp.azurewebsites.net/retailers/:retailerid/orders/:orderid","description":"

Description

The GET /retailers/:retailerId/orders/:orderId endpoint retrieves the details of a specific order for a given retailer.

There are validations in place query params that are part of the url, they will act as a guide to create the correct path and retrieve the desired information as expected.

Two types of answers (status code) come from the endpoint, 200and 404. You can find the related documentation lines blow

The GET /inventory endpoint retrieves the Portia & Scarlett inventory that is either at or en-route to the United States (US) and China (CHN) locations. Two types of answers (status code) come from the endpoint, 200, and 500. You can find the related documentation lines below. The requests with status 200 bring the inventory data with the \"date\" field. This field represents the date that the product is expected to arrive in the specified location.