Query parameters

• page integer

  Page Number

  Minimum value is 1. Default value is 1.

• pageSize integer

  Page Size

  Maximum value is 1000. Default value is 10.

• status string

  Status

  Values are CANCELLED, PROCESSING, ALLOCATED, IN TRANSIT, or COMPLETED.

• productFields array[string]

  Fields of the product each row points at to return in its productFields object (LineProduct). Repeat the parameter once per field: ?productFields=size&productFields=color. The values are the product as it is now, not as sent with the order; a field the product has no value for (an empty text included) is left out, numbers are returned as stored (0 included), and productFields is left out for a row whose key matches no product. info, customFields and externalAttributes can make the response much larger

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • cancelledDate string

    Date that the order was cancelled

  • completedDate string

    Date that the order was received and completed:

  • deliveredQuantity integer

    Quantity that has been relocated

  • deliveryDate string

    Date that the order will be delivered

  • deliveryWindow string

    Delivery Window of DO (if any)

  • externalComment string

    External Comment

  • externalDistributionOrderId string Required

    The external distribution order id used as a header

  • externalRowId string

    The external row id

  • fromWarehouseExternalId string Required

    The external id of the warehouse where quantity is moved from

  • id integer
  • key string Required

    Key, used as a reference to source system

  • label string

    Label of the DO (if any)

  • orderDate string Required

    Date that the purchase order was created

  • orderType string

    Order type of DO (if any)

  • productFields object

    The SKU the key points at as it is now, with the fields named in productFields. Absent when productFields is not sent or the key matches no SKU. Read-only: ignored when sent on a write.

    Hide productFields attributes Show productFields attributes object

    • ageGroup string

      AgeGroup associated with the product

    • brandName string

      Name of the products brand

    • categoryName string

      Category of product

    • collection string

      Collection that the product belongs to

    • color string

      Color associated with the variant

    • costPrice number

      CostPrice of the variant

    • costPriceCurrency string

      CostPriceCurrency of the variant

    • customFields object

      Custom fields of the product (json)

    • department string

      Department associated with the product

    • ean string

      EAN of variant

    • endDate string

      Date the SKU stops selling (YYYY-MM-DD)

    • externalAttributes object

      External attributes of the product (json)

    • gender string

      Gender associated with the product

    • imageUrl string

      Image of the product

    • info object

      Any info / data needed by the integration (json)

    • key string

      Key used between products, transaction & stock tables, without the season on accounts with versions

    • moq integer

      Minimum Order Quantity of variant

    • packsize integer

      Packsize

    • productGroupID string

      ProductGroupID is used to group products together within Madden

    • productMoq integer

      Minimum Order Quantity of product

    • productName string

      Name of product

    • productType number

      Type of product (1: Normal/standard, 2: Commission, 3: Local)

    • productionLeadTimeDays integer

      Production lead time of the SKU in days

    • season string

      Season that the product belongs to

    • shippingLeadTimeDays integer

      Shipping lead time of the SKU in days

    • size string

      Size associated with the variant

    • sku string

      SKU of product. Unique per size/variant

    • startDate string

      Date the SKU starts selling (YYYY-MM-DD)

    • status number

      Status of the variant (1: Inactive, 2: Active, 3: Outgoing)

    • subCategory string

      Subcategory of product

    • supplier string

      Supplier of the product

    • supplierPrice number

      Price to produce

    • supplierPriceCurrency string

      Currency to produce

    • unitVolume number

      Unit volume of the product in meters (l*w*h) (CBM)

    • variantExternalID string

      ID of variant in external platform

    • variantGroupID string

      VariantGroupID is used to group variants

    • variantName string

      Name of specific variant

    • vatValue number

      Vat Value is the percentage of VAT

    • vendorSKU string

      Vendors SKU if using own sku structure

    • weight number

      Weight of the product in kilograms (kg)

    • year string

      Start of the products life-cycle

  • quantity integer

    Quantity to be relocated

  • season string

    Season that the key belong to. Only used for product versioning.

  • shippedAt string

    Date that the order was shipped

  • sku string

    SKU of variant. Should be unique per size/variant

  • status string

    Default values that are set based on other fields: CANCELLED if CancelledAt is set, COMPLETED if DeliveredQuantity >= Quantity else PROCESSING. Additional possible statuses: ALLOCATED, IN TRANSIT. (handled manually)

    Values are CANCELLED, PROCESSING, ALLOCATED, IN TRANSIT, or COMPLETED.

  • toWarehouseExternalId string Required

    The external id of the warehouse where quantity is moved to

• default application/json

  All errors will return the same object with a describing code & message

  Hide response attributes Show response attributes object

  • error string
  • message string
  • statusCode integer