Understand the External Purchase Orders API, what values are expected and what each of them mean.
Swagger Documentation
You can find this endpoint in the External Purchase Orders section of the swagger documentation.
Access
To authenticate against this endpoint you will need to use your Secret Access Keys.
Find out more here.
Request example:
{
"customerReference": "string",
"quantity": 0,
"atelierCode": "string",
"deliveryLocation": {
"locationName": "string",
"addressLine1": "string",
"addressLine2": "string",
"countryTitle": "string",
"city": "string",
"province": "string",
"zipCode": "string"
},
"invoiceAddress": {
"addressName": "string",
"addressLine1": "string",
"addressLine2": "string",
"countryTitle": "string",
"city": "string",
"province": "string",
"zipCode": "string"
},
"deliveryDates": {
"fromDate": "2024-04-26T12:07:45.129Z",
"toDate": "2024-04-26T12:07:45.129Z"
}
Accepted Values:
Values you can send in the request:
Customer Reference
Description: Customer reference can be any reference to help you tie the order back to your system (e.g. you have an internal PO number)
Required or Optional: Optional
Request Body: customerReference
Example Value: PO123456
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 40 characters
Quantity
Description: The numbers of units in this order
Required or Optional: Required
Request Body: quantity
Example Value: 10
Validation Rules: Integer field (no decimals, no commas), Maximum value: 999,999, Minimum value: 1
Atelier Code
Description: The Loupe identifier for the variant you are ordering
Required or Optional: Required
Request Body: atelierCode
Example Value: AZ123456
Validation Rules: Must be a valid Atelier Code
Delivery Location
You can pre-set a default delivery location in Loupe Order Settings. If you want to enter a delivery location and not use the Loupe default, or if you have not set a default delivery location in Loupe, then please review the following.
Note: The required and optional statuses below only apply if you are entering at least one parameter. To use your Loupe defined default delivery location, leave all parameter empty.
Location Name
Description: The name of the delivery location or the name of the recipient
Required or Optional: Required
Request Body: locationName
Example Value: 'New York Warehouse' or 'Ms Jade Silverman'
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 255 characters
Address Line 1
Description: The first line of the delivery address
Required or Optional: Required
Request Body: addressLine1
Example Value: 1 Main Street
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 128 characters
Address Line 2
Description: The second line of the delivery address
Required or Optional: Optional
Request Body: addressLine2
Example Value: Unit 2B
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 128 characters
Country
Description: The country of delivery
Required or Optional: Required
Request Body: countryTitle
Example Value: 'United States of America' or 'USA'
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 128 characters
City
Description: The city of delivery
Required or Optional: Required
Request Body: city
Example Value: Dallas
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 128 characters
Province (County)
Description: The province or county of delivery
Required or Optional: Required
Request Body: province
Example Value: Texas
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 128 characters
Zip Code (Postcode)
Description: The zip code or postcode of the delivery address
Required or Optional: Required
Request Body: zipCode
Example Value: '75001' or 'DE10NQ'
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 15 characters
Invoice Address
You can pre-set a default invoice address in Loupe Order Settings. If you want to enter a invoice address and not use the Loupe default, or if you have not set a default invoice address, then please review the following.
Note: The required and optional statuses below only apply if you are entering at least one parameter. To use your Loupe defined default invoice address, leave all parameter empty.
Address Name
Description: The company name or the name of the recipient of the invoice
Required or Optional: Required
Request Body: addressName
Example Value: 'Retailer & Co.' or 'Ms Jade Silverman'
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 255 characters
Address Line 1
Description: The first line of the invoice address
Required or Optional: Required
Request Body: addressLine1
Example Value: 1 Main Street
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 128 characters
Address Line 2
Description: The second line of the invoice address
Required or Optional: Optional
Request Body: addressLine2
Example Value: Unit 2B
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 128 characters
Country
Description: The country of the invoice recipient
Required or Optional: Required
Request Body: countryTitle
Example Value: 'United States of America' or 'USA'
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 128 characters
City
Description: The city of the invoice recipient
Required or Optional: Required
Request Body: city
Example Value: Dallas
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 128 characters
Province (County)
Description: The province or county of the invoice recipient
Required or Optional: Required
Request Body: province
Example Value: Texas
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 128 characters
Zip Code (Postcode)
Description: The zip code or postcode of the invoice address
Required or Optional: Required
Request Body: zipCode
Example Value: '75001' or 'DE10NQ'
Validation Rules: Alpha-numeric field, Special Characters allowed, Maximum 15 characters
Delivery Dates
Delivery dates are completely flexible - you can put in just a 'Delivery From' date, just a 'Delivery To' date, both or neither.
Note: If you are entering a window, please make sure that the 'From' date is either the same as, or earlier than the 'To' date.
From Date
Description: The earliest date in the specified delivery window
Required or Optional: Optional
Request Body: fromDate
Example Value: 2024-04-26T00:00:00.000Z
Validation Rules: Valid date in format specified above
To Date
Description: The latest date in the specified delivery window
Required or Optional: Optional
Request Body: toDate
Example Value: 2024-04-26T00:00:00.000Z
Validation Rules: Valid date in format specified above