Skip to main content

products

idinteger

The id is an internally assigned id of a product. It is possible to assign an arbitrary value in a POST request to cross-reference within the message itself. However the system will not honour any value assigned by external systems.

Example: 1267733
type
Constant value: product
Default value: product
attributes object
skuproductSkurequired

SKU (stock keeping unit) of a product used to identify products.

Possible values: >= 2 characters and <= 80 characters, Value must match regular expression ^[\x21-\x7E][\x20-\x7E]*[\x21-\x7E]$

Examples:
Example: TSH-000-S
statusproductStatus

The productStatus indicates the availability of the product. The possible values are AVAILABLE, DISCONTINUED and END_OF_LIFE. See the table below for more details.

statusdescription
AVAILABLEThe product is available and active. It is actively being sold and new stock can be received
DISCONTINUEDThe product is still available, but new stock will no longer be expected.
END_OF_LIFEThe product is no longer active and will no longer show in the reports.

Possible values: [AVAILABLE, DISCONTINUED, END_OF_LIFE]

Examples:
Example: AVAILABLE
stockLevelTypestockLevelTyperequired

Specifies which type of stockLevel is to be used for stock synchronization for this particular product.

Possible values: [AVAILABLE, ECONOMIC]

typeproductType

The productType indicates the type of the product .

statusdescription
DEFAULTThe product a regular product which can be sold and shipped.
DEFAULT_IN_PACKAGINGSame as DEFAULT, but when ordered individually the product will be shipped without packaging.
COMPOSITEUsed for products that are composed out of other products of type PART. Composite products are stocked, picked and shipped as a single SKU and cannot be split into their consituent parts. This is important as consumers will notbe able to return these parts individually. Also note that composite products can also run out of stock eventhough the parts may still be in stock. This is because new stock of composite products is created through special work orders.
BUNDLEThe product is a bundled product which means that the product itself is not kept on stock, but when ordered, its parts are picked and shipped instead. When ordering a bundled product the system will automatically add the parts to the order as separate orderItems. Bundled products can be partially returned as each item is a separate product, they can also be split across shipments if packaging constraints prevent them from being shipped together.
PARTThe product is a part of one or more COMPOSITE products.
GREETING_CARDA special type of product used to add a personalized greeing card to the order. This requires the greeting to be added to the metadata field on the orderItem with the name extra6.
SERVICEA special type of product used in very specific situations.

Possible values: [DEFAULT, COMPOSITE, PART, DEFAULT_IN_PACKAGING, BUNDLE, GREETING_CARD, SERVICE]

Default value: DEFAULT
Example: BUNDLE
weightinteger

This field indicates the weight of the product, measured in grams. It is important to note that the weight is determined when the product is first processed in an inbound shipment and can only be set or modified on request.

Example: 154
lengthinteger

The length of the product in millimeters, notice that this value can not be specified. It will be measured once the product is received for the first time.

Example: 33
widthinteger

The width of the product in millimeters, notice that this value can not be specified. It will be measured once the product is received for the first time.

Example: 65
heightinteger

The height of the product in millimeters, notice that this value can not be specified. It will be measured once the product is received for the first time.

Example: 125
namestringrequired

Short name for the product used on packing slips if required. Note that this name is used mostly internally and when the orderItem.name is not provided.

Possible values: non-empty and <= 250 characters

Example: Dog Shampoo 100ml
descriptionstring

A more complete description of the product.

Possible values: <= 10000 characters

Example: Experience the ultimate pampering for your furry friend with our premium 100ml Dog Shampoo. Specially designed with your canine companion in mind, this gentle and nourishing formula will leave their coat looking and feeling fabulous. Every drop of our shampoo is packed with the finest natural ingredients, carefully selected to provide optimal cleansing without causing any irritation or dryness.
hasBarcodeboolean

Specifies if the product has a barCode or not. When set to true a barcode will be scanned during the first inbound or when already known the barcode can be specified in the barcode field.

Default value: false
barcodeproductBarcode

The barcode of the product, when set will ensure that the hasBarcode is true as well.

Possible values: >= 2 characters and <= 80 characters, Value must match regular expression ^[\x21-\x7E][\x20-\x7E]*[\x21-\x7E]$

Examples:
Example: TSH-000-S
hasLotNumberboolean

Specifies if the product has a lotNumber or not. Defaults to false.

Default value: false
hasSerialNumberboolean

Specifies if the product has a serialNumber or not. Defaults to false.

Default value: false
hasExpirationDateboolean

Specifies if the product has an expirationDate or not. Defaults to false.

Default value: false
expirationDateMargininteger

The expirationDateMargin is the number of days used to determine whether particular stock can still be sold or if it has expired. Stock of a product is expired when the difference of the current date with and expirationDate of the stock is more than the expirationDateMargin speficied on the product. This field is optional when expirationDate is NONE.

expirationDateWarninginteger

The expirationDateWarning is the number of days used to determine is a product nearing its expiration date. This field is optional when expirationDate is NONE.

countryOfOrigincountryCode

A valid ISO:3166-1 alpha-2 country code denoting the country of origin for the product. This value is required for international shipments.

Possible values: Value must match regular expression ^[A-Z]{2,2}(-[A-Z0-9]{2,3})?$

Examples:
Example: NL
hsCodes object[]

An array of hsCodes (or more specific equivalents thereof) for this product. To set a default/fallback hsCode for the product use country code XX. It is not mandatory to specify hsCodes, but when provigind the element the array should contain at least one entry.

  • Array [
    • countrycountryCoderequired

    A valid ISO:3166-1 alpha-2 country code denoting the country or region the hsCode is applicable for. Use XX to denote the default/fallback hsCode for the product.

    Possible values: Value must match regular expression ^[A-Z]{2,2}(-[A-Z0-9]{2,3})?$

    Examples:
    Example: NL
    hsCodehsCoderequired

    The hsCode stands for Harmonized System code, which is a standardized numerical method of classifying traded products. It is used by customs authorities around the world to identify and track goods as they cross borders. The Harmonized System is maintained by the World Customs Organization (WCO) and is recognized as the global standard for product classification. It consists of a six-digit code that can be further detailed with additional digits. Standard hsCodes are six digits long, but more specific variants such as TARIC can use more.

    Possible values: >= 6 characters and <= 12 characters, Value must match regular expression \d{6,12}

    Examples:
    Example: 620342
  • ]
    • purchasePrice object[]

    Specifies the purchase price of the product. At the moment only a single price in EUR is supported. Any currency code provided will be ignored.

    Possible values: <= 1

  • Array [
    • currencystringrequired

    The currency symbol for this amount must always be set to EUR.

    Possible values: Value must match regular expression EUR

    Default value: EUR
    amountnumberrequired
    Example: 9,55
  • ]
    • metadata object
    extra1string

    Possible values: <= 250 characters

    extra2string

    Possible values: <= 250 characters

    extra3string

    Possible values: <= 250 characters

    extra4string

    Possible values: <= 250 characters

    extra5string

    Possible values: <= 250 characters

    relationships object
    stockLevels object

    Convenience relationship to the stockLevel of the product.

    data object

    Represents a self-link of a stock resource.

    idinteger
    type
    Constant value: stockLevel
    Default value: stockLevel
    links object
    selfstring<uri>
    Example: https://shopapi.activeants.nl/v3/stockLevels/
    parts object

    Provided when the product is of type BUNDLE or COMPOSITE. The array contains references to the constituent products and the quantity they appear in in this bundle.

    data object[]
  • Array [
    • idinteger

    The id is an internally assigned id of a product. It is possible to assign an arbitrary value in a POST request to cross-reference within the message itself. However the system will not honour any value assigned by external systems.

    Example: 1267733
    type
    Constant value: product
    Default value: product
    quantityinteger

    Possible values: > 0

    links object
    selfstring<uri>
    Example: https://shopapi.activeants.nl/v3/products/1267733
  • ]
    • links object
    selfstring<uri>
    Example: https://shopapi.activeants.nl/v3/products/1267733
    products
    {
      "id": 1267733,
      "attributes": {
        "sku": "TSH-000-S",
        "status": "AVAILABLE",
        "stockLevelType": "AVAILABLE",
        "type": "BUNDLE",
        "weight": 154,
        "length": 33,
        "width": 65,
        "height": 125,
        "name": "Dog Shampoo 100ml",
        "description": "Experience the ultimate pampering for your furry friend with our premium 100ml Dog Shampoo. Specially designed with your canine companion in mind, this gentle and nourishing formula will leave their coat looking and feeling fabulous. Every drop of our shampoo is packed with the finest natural ingredients, carefully selected to provide optimal cleansing without causing any irritation or dryness.",
        "hasBarcode": false,
        "barcode": "TSH-000-S",
        "hasLotNumber": false,
        "hasSerialNumber": false,
        "hasExpirationDate": false,
        "expirationDateMargin": 0,
        "expirationDateWarning": 0,
        "countryOfOrigin": "NL",
        "hsCodes": [
          {
            "country": "NL",
            "hsCode": 620342
          }
        ],
        "purchasePrice": [
          {
            "currency": "EUR",
            "amount": "9,55"
          }
        ],
        "metadata": {
          "extra1": "string",
          "extra2": "string",
          "extra3": "string",
          "extra4": "string",
          "extra5": "string"
        }
      },
      "relationships": {
        "stockLevels": {
          "data": {
            "id": 0,
            "links": {
              "self": "https://shopapi.activeants.nl/v3/stockLevels/"
            }
          }
        },
        "parts": {
          "data": [
            {
              "id": 1267733,
              "quantity": 0,
              "links": {
                "self": "https://shopapi.activeants.nl/v3/products/1267733"
              }
            }
          ]
        }
      },
      "links": {
        "self": "https://shopapi.activeants.nl/v3/products/1267733"
      }
    }