Query parameters

• productFields array[string]

  Fields of the product each line 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 line whose key matches no product. info, customFields and externalAttributes can make the response much larger

• page integer

  Page Number

  Minimum value is 1. Default value is 1.

• pageSize integer

  Page Size

  Default value is 10.

• status string

  Filter by order status

  Values are all, processing, completed, or cancelled. Default value is all.

• global string

  Return transactions from all api key origins. Default = false

• type string

  Filter by order type

  Values are purchase or return. Default value is all.

• channel string

  Filter by channel

  Values are d2c or b2b. Default value is all.

• externalid string

  Filter by externalID

• externalrowid string

  Filter by externalRowID

• from string

  Filter by date in layout 2006-01-02T15:04:05Z07:00 or 2006-01-02T15:04:05-0700, inclusive

• to string

  Filter by date in layout 2006-01-02T15:04:05Z07:00 or 2006-01-02T15:04:05-0700, exclusive

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • cancelledDate string(date-time)

    Date that the transaction was cancelled

  • channel number Required

    Channel of the transaction (1: D2C, 2: B2B)

  • completedDate string(date-time)

    Date that the transaction was completed

  • createdDate string(date-time) Required

    Date that the transaction was created

  • currencyCode string Required

    Currency Code of transaction (ISO 4217)

  • customerName string

    Name of the Customer (Only used on B2B transactions)

  • deliveryDate string

    The estimated Delivery Date of the transaction

  • externalCostCenterID string

    External ID of an assosciated cost center. Will be added as a suffix to externalStoreID

  • externalCustomerID string

    External Customer ID of the B2B customer

  • externalInfo string

    JSON body that can be used for integration purposes

  • externalParentID string

    Reference externalTransactionID of initial transaction when adding returns

  • externalRowID string

    Additional ExternalID of transaction

  • externalStoreID string Required

    External ID of the store (Store must exist in Madden)

  • externalTransactionID string Required

    The ID of the transaction in the source platform (used to query single transacitons)

  • id integer

    Maddens ID of the transaction (Used as reference on replace)

  • invoicedDate string(date-time)

    Invoiced at

  • items array[object]

    The items/product rows of the transaction

    Hide items attributes Show items attributes object

    • ageGroup string

      AgeGroup assosciated with the variant

    • brandName string Required

      Brand Name of the variant

    • category string Required

      Category of the variant

    • collection string

      Collection that the variant belongs to

    • color string

      Color of the variant

    • costPrice number(float)

      Cost Price per unit on transaction row

    • costPriceCurrency string

      Currency Code of Cost Price (ISO 4217)

    • customFields string

      Any JSON object holding additional filter attributes

    • deliveryDate string(date-time)

      Item-level delivery date. When set, it overrides the transaction's delivery date for this item (the child shadows the parent), driving the estimated delivery date when the item has no shipment.

    • deliveryWindow string

      Name of Delivery Window assosciated with the variant

    • department string

      Department assosciated with the variant

    • ean string

      Ean of the variant

    • externalID string

      Id of variant in external platform

    • externalItemID string Required

      ExternalItemID the external id of the transaction item

    • fulfillmentType number

      Method of fulfillment for transaction item (0: Warehouse, 1: DropShip)

      Default value is 0.

    • invoicedDate string(date-time)

      Date that the transaction was invoiced (fallbacks to completedAT if not set)

    • key string Required

      Key used between products, transaction & stock tables. Usually SKU or EAN but needs to be same on all occurrences of the variant

    • moneyDiscount number(float)

      Any discounts given on transaction row (ex. VAT)

    • moneyDiscountIncVat number(float)

      Any discounts given on transaction row (inc. VAT). This field is optional but if provided will override MoneyDiscount (required vatValue)

    • moneyItemTotalNet number(float) Required

      Total of the items on transaction row ex. VAT

    • moneyItemTotalVat number(float) Required

      Total VAT of the items on the transaction row

    • primaryWarehouseExternalID string

      External ID of the warehouse where items WILL be allocated

    • 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

    • productGroupID string

      ProductGroupID of the variant (used to group variants together)

    • productName string Required

      Name of the Product

    • productType number

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

      Default value is 1.

    • quantity integer Required

      Quantity of the variant purchased

    • season string

      Season that the variant belong to

    • shipments array[object]

      Shipments assosciated with the transaction row

      Hide shipments attributes Show shipments attributes object

      • externalWarehouseID string

        External ID of the warehouse where items were allocated

      • quantity integer

        Quantity shipped

      • shipmentDate string(date-time)

        Date the shipment was created

      • shipmentID string

        External ID of the shipment

    • size string

      Size of the variant

    • sku string

      SKU of the variant

    • supplier string

      Name of the supplier of the variant

    • type number

      Overrides the Type of the transaction (1: Sale, 2: Return), Note that Return should also change item Quantity/Price/CostPrice to negative

    • variantGroupID string

      VariantGroupID of the variant (used to group skus/sizes together)

    • variantName string Required

      Name of the Variant

    • vatValue number Required

      VAT Percentage on the item

    • vendorSKU string

      Vendors SKU if using own sku structure

    • year string

      Start of the variants life-cycle

  • market string Required

    Market that the transaction was destined for. (Ex. Delivery Country)

  • orderType string

    OrderType of the transaction

  • statements array[object]

    Any fees/discounts applied to the whole transaction that are not directly tied to a transaction item

    Hide statements attributes Show statements attributes object

    • customFields string

      Custom Fields

    • invoicedDate string(date-time)

      Date that the statement was invoiced. Optional; falls back to the transaction invoicedDate (and completedDate for accounts without explicit invoicing)

    • name string

      Name of the Statement

    • priceNet number

      Statement Price (ex VAT)

    • priceVat number

      VAT of statement

    • type number

      Type of the statement (1: Fee, 2: Voucher, 3: Shipping, 4: Service, 5: Giftcard, 6: CartDiscount)

  • type number Required

    Type of the transaction (1: Sale, 2: Return), Note that Return should also change item Quantity/Price/CostPrice to negative

• 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