Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Items

Retrieve an item

Returns the details of an item.

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/{id}

Path parameters

idinteger required

ID for the item to be included in the filter

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"
    }
  ]
}