Path parameters

• externalTransactionID string Required

  External Transaction ID

Query parameters

• 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.

Responses

• 200

  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)

  • 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 of the items on transaction row

    • costPriceCurrency string

      Currency Code of Cost Price (ISO 4217)

    • customFields string

      Any JSON object holding additional filter attributes

    • deliveryWindow string

      Name of Delivery Window 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.

    • gender string

      Gender assosciated with the variant

    • 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

      Any discounts given on transaction row

    • 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

    • 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

    • variantGroupID string

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

    • variantName string Required

      Name of the Variant

    • vatValue integer 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

    • 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)

• default

  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