Order API - Get Products

Get products

Endpoint: GET *base*/products
Authentication: API Key

This will return product data from Centra with categories.

Parameters

sku
string
optional

Get products with a specific SKU.

modified
date/datetime
optional

Get all products modified after a certain date. Allowed formats YYYY-mm-dd and YYYY-mm-dd HH:MM:SS. Timezone is system-wide and decided by the company using Centra.

created
date/datetime
optional

Get all products added after a certain date. Allowed formats YYYY-mm-dd and YYYY-mm-dd HH:MM:SS. Timezone is system-wide and decided by the company using Centra.

ean
string
optional

Get a product with specified EAN code.

productId variantId stockItemID
int
optional

Filter products based on product, variant and stock item IDs.

limit
int
optional

You will get this amount of products, and a "next" parameter in return if there are multiple pages. This will go a lot faster to fetch, instead of fetching all products at once.

include
string
optional

include=attributes will also make the products include the custom attributes defined for each product and variant.

xml
boolean
optional

Response in xml format instead of json.

Request example

GET <base>/products HTTP/1.1
Content-type: application/json

Response

200 Content-type: application/json

status
string
required

ok if success, else no.

products
array
required

List of the products.

products
array
optional

List of the products.

sku
string
optional

SKU for this product.

product
string
optional

The internal name for this product.

productId
int
optional

ID for this product.

name
string
optional

The externally facing name for this product.

variantSku
string
optional

SKU for this variant.

variantId
int
optional

ID for this variant.

sizeSku
string
optional

SKU for this size.

stockItemId
int
optional

ID for this specific stock item.

ean
string
optional

The EAN for this product item size.

weight
decimal2 (0.00)
optional

The weight specified for this product.

weightUnit
string
optional

The unit used for the weight.

  • kg
  • lb
size
string
optional

Name of the size for this specific product item.

active
boolean
optional

If the product item is active or not.

folder
string
optional

String with names of the folders the product belongs to.

Like this: Collection / Jackets.

countryOfOrigin
string
optional

ISO-Alpha-2 (SE, US, GB etc)

store
string
optional

Store name product is related to.

categories
array|string
optional

Array with names of the categories the product belongs to.

Like this: ["Collection / Jackets\/Outerwear", "..."].

images
array|string
optional

URLs with the images connected to this product item.

Like this: ["https://xxx.centracdn.net/x/y/z.jpg", "https://..."].

prices
array
optional

Array of the pricelists for this product.

id
int
optional

ID of the pricelist.

pricelist
string
optional

Name of the pricelist.

price
string
optional

Price for the product in this pricelist.

currency
string
optional

ISO code of the currency for this pricelist.

campaigns
array
optional

List of campaigns this product is connected to in this pricelist.

id
int
optional

ID of the campaign.

campaign
string
optional

Name of the campaign.

price
decimal2 (0.00)
optional

The price when this campaign is applied to the price. Currency will always be the same as in the pricelist.

previous
string
optional

Will contain a URL to the previous page.

next
string
optional

Will contain a URL to the next page.

Response example

{
  "status": "ok",
  "products": [
    {
      "sku": "M411-740",
      "productId": 232,
      "variantSku": "",
      "variantId": 1211,
      "sizeSku": "",
      "brand": "Odd Molly",
      "collection": "Molly Prefall 2011",
      "product": "bakers cross 3\/4 blouse",
      "variant": "LITE ROSE",
      "size": "3",
      "stockItemId": 3424,
      "ean": "",
      "weight": 0.17,
      "weightUnit": "kg",
      "countryOfOrigin": "PT",
      "harmCode": "6206300090",
      "harmDescription": "Cotton - blouse",
      "active": 0,
      "folder": "Folder 1 / Folder 2"
      "name": "Bakers Cross",
      "description": "",
      "shortDescription": "",
      "comment": "",
      "store": "Retail",
      "categories": [
        "Collection \/ Jackets\/Outerwear",
        "New Arrivals"
      ],
      "images": [
        "https:\/\/...\/images\/1_0d2f67cd05.jpg",
        "https:\/\/...\/images\/1_318da2ad06.jpg",
        "https:\/\/...\/images\/1_c4e1c20d34.jpg"
      ],
      "prices": [
        {
          "id": "36",
          "price": "329.00",
          "pricelist": "EUR Europe",
          "currency": "EUR",
          "campaigns": [
            {
              "id": "40",
              "campaign": "OUTLET 50% NY",
              "price": 164.5
            }
          ]
        },
        {
          "id": "35",
          "price": "269.00",
          "pricelist": "GBP",
          "currency": "GBP",
          "campaigns": [
            {
              "id": "40",
              "campaign": "OUTLET 50% NY",
              "price": 134.5
            }
          ]
        }
      ]
    },
    {
      "sku": "M411-740",
      "productId": 232,
      "variantSku": "",
      "variantId": 1211,
      "sizeSku": "",
      "brand": "Odd Molly",
      "collection": "Molly Prefall 2011",
      "product": "bakers cross 3\/4 blouse",
      "variant": "LITE ROSE",
      "size": "4",
      "stockItemId": 3425,
      "ean": "",
      "weight": 0.17,
      "weightUnit": "kg",
      "countryOfOrigin": "PT",
      "harmCode": "6206300090",
      "harmDescription": "Cotton - blouse",
      "active": 0,
      "name": "Bakers Cross",
      "description": "",
      "shortDescription": "",
      "comment": "",
      "store": "Retail",
      "categories": [
        "Collection \/ Jackets\/Outerwear",
        "New Arrivals"
      ],
      "images": [
        "https:\/\/...\/images\/1_0d2f67cd05.jpg",
        "https:\/\/...\/images\/1_318da2ad06.jpg",
        "https:\/\/...\/images\/1_c4e1c20d34.jpg"
      ]
      "prices": [
        {
          "id": "36",
          "price": "329.00",
          "pricelist": "EUR Europe",
          "currency": "EUR",
          "campaigns": [
            {
              "id": "40",
              "campaign": "OUTLET 50% NY",
              "price": 164.5
            }
          ]
        },
        {
          "id": "35",
          "price": "269.00",
          "pricelist": "GBP",
          "currency": "GBP",
          "campaigns": [
            {
              "id": "40",
              "campaign": "OUTLET 50% NY",
              "price": 134.5
            }
          ]
        }
      ]
    }
  ],
  "previous": "?limit=10&page=2",
  "next": "?limit=10&page=3"
}

Previous article: Order API - Update return
Next article: Order API - Get Stock