OMS - ExternalPurchaseOrders API

Documentation for ExternalPurchaseOrders API

Endpoints

POST - /api/external/purchaseorders/submit

Parameters

• customerReference (string, required): A reference to help the retailer map the order to internal systems.
• quantity (integer, required): Number of item units in order.
• atelierCode (integer, required): The Loupe ID of the item being ordered.
• deliveryLocation (object, optional): Location to which the order will be delivered.

• • locationName (string, required): Name of the location
  • addressLine1 (string, required): Address line 1
  • addressLine2 (string, optional): Address line 2
  • countryTitle (string, required): Name of the country
  • city (string, required): Name of the city
  • province (string, required): Name of the province or state
  • zipCode (string, required): Zip code or postal code

• invoiceAddress (object, optional): Location to which the order will be invoiced.
  • addressName (string, required): Name of the address
  • addressLine1 (string, required): Address line 1 (e.g., street, PO Box, or company name).
  • addressLine2 (string, optional): Address line 2 (e.g., apartment, suite, unit, or building).
  • countryTitle (string, required): Name or abbreviation of the country
  • city (string, required): City, district, suburb, town, or village.
  • province (string, required): State, county, province, or region.
  • zipCode (string, required): ZIP or postal code.

• deliveryDates (object, required): Dates between which the order is to be delivered.

• • fromDate (date-time, required): Date from which the order is to be delivered
  • toDate (date-time, required): Date by which the order is to be delivered