Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Items

List all items

Returns a list of items.

Items are the products and services that are sold as part of an order. They are created by a unique SKU when an order is placed, through item import, or through the API.

get/items

Query parameters

idinteger

ID of the item that needs to be considered for filter

skustring

SKU of the item that needs to be considered for filter

namestring

Name of the item that needs to be considered for filter

barcodestring

The barcode value of the item that needs to be considered for filter

created_at_minstring date-time

"From" timestamp for the items to be included in the filter. Examples:

  • 2017-06-19T11:00:03.305+02:00
  • 2017-06-19 will be transformed into 2017-06-19T00:00:00.000+02:00
created_at_maxstring date-time

"To" timestamp for the items to be included in the filter. Examples:

  • 2017-06-29T11:00:03.305+02:00
  • 2017-06-29 will be transformed into 2017-06-29T00:00:00.000+02:00
updated_at_minstring date-time

"From" value of "updated" timestamp for the items to be included in the filter. Examples:

  • 2018-06-19T11:00:03.305+02:00
  • 2018-06-19 will be transformed into 2017-06-19T00:00:00.000+02:00
updated_at_maxstring date-time

"To" value of "updated" timestamp for the items to be included in the filter. Examples:

  • 2018-06-29T11:00:03.305+02:00
  • 2018-06-29 will be transformed into 2017-06-29T00:00:00.000+02:00
per_pageinteger

For pagination. Defines how many entries are returned per page.

pageinteger

For pagination. Defines which page the results are fetched from.

Response

Successful.

idinteger required

Unique identifier of the object.

skustring

SKU (stock keeping unit). Must be unique for every item, including variants.

namestring

Name of the item.

variant_codestring

Variant code of the item.

barcodestring

Barcode of the item, which is used when scanning item for pick. Will be displayed as a code 128 barcode

binstring

The bin/location where the item is located in the warehouse.

weightinteger

Weight of the item in grams.

image_urlstring

Image URL of the item that appears on the order or when picking. Will only be displayed if the URL is HTTPS.

country_code_of_originstring

ISO 3166-1 alpha-2 country code of origin.

currency_codestring

ISO 4217 currency code.

customs_commodity_codestring

Global tariff code for the item. Used when creating shipments that require customs declaration.

customs_descriptionstring

Customs description for the item. Used when creating shipments that require customs declaration.

shopstring

Origin shop of the item.

virtualboolean

Describes if the item is a virtual item.

Example response

[
  {
    "id": 1,
    "sku": "EX-123",
    "name": "T-Shirt",
    "variant_code": "Large",
    "barcode": "1234567891011",
    "bin": "123-a",
    "weight": 1000,
    "image_url": "https://example.com/image.jpg",
    "country_code_of_origin": "DK",
    "currency_code": "DKK",
    "customs_commodity_code": "123456",
    "customs_description": "Example contents",
    "shop": "API",
    "country_attributes": [
      {
        "country_code": "DK",
        "customs_commodity_code": "3924102000"
      }
    ]
  }
]