List Products

GET /v1/products

Lists all Products

Body Required

  • Suppliers

  • ageGroup string

    AgeGroup assosciated with the product

  • brandName string Required

    Name of the products brand

  • categoryName string Required

    Category of product. Should be a relevant for segmentation

  • Collection that the product belongs to

  • color string Required

    Color assosciated with the variant

  • CostPrice of the Variant

  • CostPriceCurrency of the Variant

  • Any JSON object holding additional filter attributes

  • ean string

    EAN of Variant

  • gender string

    Gender assosciated with the product

  • id integer
  • info object

    Any info / data needed by the integration (json)

  • key string Required

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

  • leadTime integer

    Lead Time of variant in months

  • moq integer

    Minimum Order Quantity of variant

  • price number

    Sales Price of the Variant (Excl VAT)

  • Sales Price Currency of the Variant

  • If Price is including VAT or not

  • productGroupID string Required

    ProductGroupID is used to group products together within Madden

  • productName string Required

    Name of product

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

    Values are 1, 2, or 3. Default value is 1.

  • season string

    Season that the product belongs to

  • size string Required

    Size assosciated with the variant

  • sku string

    SKU of product. Should be unique per size/variant

  • skuSynonyms array[string]

    List of sku synonyms that should point to this variant

  • status number

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

    Values are 1, 2, 3, 4, 5, 6, or 7. Default value is 2.

  • subCategory string Required

    Subcategory of product. Should be a relevant for segmentation

  • supplier string

    Supplier of the Product

  • Price to produce

  • Currency to produce

  • ID of variant in external platform

  • VariantGroupID is used to group variants

  • variantName string Required

    Name of specific variant

  • vatValue integer

    Vat Value is the percentage of VAT

  • Vendors SKU if using own sku structure

  • Wholesale price of the Variant (Excl VAT)

  • Currency Code of the Wholeale Price

  • year string

    Start of the porducts life-cycle

Responses

  • OK

    Hide response attributes Show response attributes object
    • Suppliers

    • ageGroup string

      AgeGroup assosciated with the product

    • brandName string Required

      Name of the products brand

    • categoryName string Required

      Category of product. Should be a relevant for segmentation

    • Collection that the product belongs to

    • color string Required

      Color assosciated with the variant

    • CostPrice of the Variant

    • CostPriceCurrency of the Variant

    • Any JSON object holding additional filter attributes

    • ean string

      EAN of Variant

    • gender string

      Gender assosciated with the product

    • id integer
    • info object

      Any info / data needed by the integration (json)

    • key string Required

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

    • leadTime integer

      Lead Time of variant in months

    • moq integer

      Minimum Order Quantity of variant

    • price number

      Sales Price of the Variant (Excl VAT)

    • Sales Price Currency of the Variant

    • If Price is including VAT or not

    • productGroupID string Required

      ProductGroupID is used to group products together within Madden

    • productName string Required

      Name of product

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

      Values are 1, 2, or 3. Default value is 1.

    • season string

      Season that the product belongs to

    • size string Required

      Size assosciated with the variant

    • sku string

      SKU of product. Should be unique per size/variant

    • skuSynonyms array[string]

      List of sku synonyms that should point to this variant

    • status number

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

      Values are 1, 2, 3, 4, 5, 6, or 7. Default value is 2.

    • subCategory string Required

      Subcategory of product. Should be a relevant for segmentation

    • supplier string

      Supplier of the Product

    • Price to produce

    • Currency to produce

    • ID of variant in external platform

    • VariantGroupID is used to group variants

    • variantName string Required

      Name of specific variant

    • vatValue integer

      Vat Value is the percentage of VAT

    • Vendors SKU if using own sku structure

    • Wholesale price of the Variant (Excl VAT)

    • Currency Code of the Wholeale Price

    • year string

      Start of the porducts life-cycle

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

    Hide response attributes Show response attributes object
GET /v1/products
curl \
 -X GET https://ma-api.maddenanalytics.com/v1/products \
 -H "Authorization: $API_KEY" \
 -d '{"additionalSuppliers":{},"ageGroup":"Senior","brandName":"Acme","categoryName":"Sneakers","collection":"SS21","color":"Black","costPrice":42,"costPriceCurrency":"USD","customFields":"{}","ean":"7340192703345","gender":"Unisex","id":42,"info":{},"key":"7340192703345","leadTime":3,"moq":300,"price":42,"priceCurrency":"USD","priceIncludingVat":true,"productGroupID":"123456","productName":"Petter","productType":1,"season":"Spring/Summer","size":"43","sku":"123456-001-43","skuSynonyms":["string"],"status":2,"subCategory":"Low Sneakers","supplier":"string","supplierPrice":42,"supplierPriceCurrency":"string","variantExternalID":"shopify_432345","variantGroupID":"123456-001","variantName":"Petter Black","vatValue":25,"vendorSKU":"9876543-001-43","wholesalePrice":42,"wholesalePriceCurrency":"USD","year":"2021"}'
Request example
{
  "additionalSuppliers": {},
  "ageGroup": "Senior",
  "brandName": "Acme",
  "categoryName": "Sneakers",
  "collection": "SS21",
  "color": "Black",
  "costPrice": 42,
  "costPriceCurrency": "USD",
  "customFields": "{}",
  "ean": "7340192703345",
  "gender": "Unisex",
  "id": 42,
  "info": {},
  "key": "7340192703345",
  "leadTime": 3,
  "moq": 300,
  "price": 42,
  "priceCurrency": "USD",
  "priceIncludingVat": true,
  "productGroupID": "123456",
  "productName": "Petter",
  "productType": 1,
  "season": "Spring/Summer",
  "size": "43",
  "sku": "123456-001-43",
  "skuSynonyms": [
    "string"
  ],
  "status": 2,
  "subCategory": "Low Sneakers",
  "supplier": "string",
  "supplierPrice": 42,
  "supplierPriceCurrency": "string",
  "variantExternalID": "shopify_432345",
  "variantGroupID": "123456-001",
  "variantName": "Petter Black",
  "vatValue": 25,
  "vendorSKU": "9876543-001-43",
  "wholesalePrice": 42,
  "wholesalePriceCurrency": "USD",
  "year": "2021"
}
Response examples (200)
[
  {
    "additionalSuppliers": {},
    "ageGroup": "Senior",
    "brandName": "Acme",
    "categoryName": "Sneakers",
    "collection": "SS21",
    "color": "Black",
    "costPrice": 42,
    "costPriceCurrency": "USD",
    "customFields": "{}",
    "ean": "7340192703345",
    "gender": "Unisex",
    "id": 42,
    "info": {},
    "key": "7340192703345",
    "leadTime": 3,
    "moq": 300,
    "price": 42,
    "priceCurrency": "USD",
    "priceIncludingVat": true,
    "productGroupID": "123456",
    "productName": "Petter",
    "productType": 1,
    "season": "Spring/Summer",
    "size": "43",
    "sku": "123456-001-43",
    "skuSynonyms": [
      "string"
    ],
    "status": 2,
    "subCategory": "Low Sneakers",
    "supplier": "string",
    "supplierPrice": 42,
    "supplierPriceCurrency": "string",
    "variantExternalID": "shopify_432345",
    "variantGroupID": "123456-001",
    "variantName": "Petter Black",
    "vatValue": 25,
    "vendorSKU": "9876543-001-43",
    "wholesalePrice": 42,
    "wholesalePriceCurrency": "USD",
    "year": "2021"
  }
]
Response examples (default)
{
  "error": "Error Type (if any)",
  "message": "Message describing the error",
  "statusCode": 400
}