Products

You may find descriptions of endpoints for work with products below.

Filter products

post

Authorizations

authorizationXApiKey

Header parameters

x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body

pageinteger · min: 1Optional

Page number, can be used for pagination

Default: 1Example: 1

itemsinteger · min: 1 · max: 1000Optional

items per page

Default: 10Example: 30

Responses

200

Success response

application/json

401

Unauthorized response

application/json

post

HTTPcURLJavaScriptPython

POST /v2/products/filter HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "page": 1,
  "items": 30,
  "columns": [
    "sku",
    "guid",
    "name"
  ],
  "sorts": [
    {
      "column": "name",
      "direction": "DESC"
    }
  ],
  "filters": [
    [
      {
        "column": "productType",
        "operator": "eq",
        "value": "finalProduct"
      }
    ]
  ]
}

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "data": [
      {
        "sku": "APPLEIPHONE13",
        "name": "Apple Iphone 13",
        "description": "Smartphone from Apple",
        "price": 20000,
        "hsCode": "text",
        "upc": "text",
        "ean": "0194252698525",
        "guid": "text",
        "rop": 1,
        "expMethod": "FIFO",
        "originCountry": "PL",
        "scanSerialNumber": false,
        "mpn": "text",
        "isbn": "text",
        "note": "some useful information",
        "productType": "finalProduct",
        "customField1": "text",
        "customField2": "text",
        "customField3": "text",
        "ageCheck": false,
        "active": true
      }
    ],
    "request": {
      "page": 1,
      "items": 30,
      "columns": [
        "sku",
        "guid",
        "name"
      ],
      "sorts": [
        {
          "column": "name",
          "direction": "DESC"
        }
      ],
      "filters": [
        [
          {
            "column": "productType",
            "operator": "eq",
            "value": "finalProduct"
          }
        ]
      ]
    },
    "totalCount": 430
  }
}

Get product by sku

get

Authorizations

authorizationXApiKey

Path parameters

skustringRequired

Header parameters

x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Responses

200

Success response

application/json

401

Unauthorized response

application/json

404

Not found response

application/json

get

HTTPcURLJavaScriptPython

GET /v2/products/{sku} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Accept: */*

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "id": 1,
    "sku": "APPLEIPHONE13",
    "name": "Apple Iphone 13",
    "description": "Smartphone from Apple",
    "price": 20000,
    "hsCode": "text",
    "upc": "text",
    "ean": "0194252698525",
    "guid": "text",
    "rop": 1,
    "expMethod": "FIFO",
    "originCountry": "PL",
    "scanSerialNumber": false,
    "mpn": "text",
    "isbn": "text",
    "note": "some useful information",
    "productType": "finalProduct",
    "customField1": "text",
    "customField2": "text",
    "customField3": "text",
    "ageCheck": false,
    "active": true
  }
}

Get product by guid

get

Authorizations

authorizationXApiKey

Path parameters

guidstringRequired

Header parameters

x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Responses

200

Success response

application/json

401

Unauthorized response

application/json

404

Not found response

application/json

get

HTTPcURLJavaScriptPython

GET /v2/products/guid/{guid} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Accept: */*

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "id": 1,
    "sku": "APPLEIPHONE13",
    "name": "Apple Iphone 13",
    "description": "Smartphone from Apple",
    "price": 20000,
    "hsCode": "text",
    "upc": "text",
    "ean": "0194252698525",
    "guid": "text",
    "rop": 1,
    "expMethod": "FIFO",
    "originCountry": "PL",
    "scanSerialNumber": false,
    "mpn": "text",
    "isbn": "text",
    "note": "some useful information",
    "productType": "finalProduct",
    "customField1": "text",
    "customField2": "text",
    "customField3": "text",
    "ageCheck": false,
    "active": true
  }
}

Creates new product

post

Authorizations

authorizationXApiKey

Header parameters

x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body

skustring · min: 1RequiredExample: APPLEIPHONE13Pattern: ^[a-zA-Z0-9_*().s,+/\- ]*$

namestring · min: 1RequiredExample: Apple Iphone 13

descriptionstring · min: 1OptionalExample: Smartphone from Apple

pricenumberOptionalExample: 20000

hsCodestring · min: 1Optional

upcstring · min: 1 · max: 50Optional

eanstringOptionalExample: 0194252698525

guidstringOptional

ropnumberOptional

expMethodstring · enumRequiredExample: FIFOPossible values:

originCountrystring · min: 2 · max: 2OptionalExample: PL

scanSerialNumberbooleanOptional

mpnstring · min: 1 · max: 50Optional

isbnstring · min: 1 · max: 50Optional

notestring · min: 1 · max: 255OptionalExample: some useful information

productTypestring · enumRequiredExample: finalProductPossible values:

customField1string · min: 1 · max: 255Optional

customField2string · min: 1 · max: 255Optional

customField3string · min: 1 · max: 255Optional

ageCheckbooleanOptional

Info whether is necessary to check recipient age by delivery service

activebooleanRequiredExample: true

Responses

200

Success response

application/json

401

Unauthorized response

application/json

post

HTTPcURLJavaScriptPython

POST /v2/products HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "sku": "APPLEIPHONE13",
  "name": "Apple Iphone 13",
  "description": "Smartphone from Apple",
  "price": 20000,
  "hsCode": "text",
  "upc": "text",
  "ean": "0194252698525",
  "guid": "text",
  "rop": 1,
  "expMethod": "FIFO",
  "originCountry": "PL",
  "scanSerialNumber": false,
  "mpn": "text",
  "isbn": "text",
  "note": "some useful information",
  "productType": "finalProduct",
  "customField1": "text",
  "customField2": "text",
  "customField3": "text",
  "ageCheck": false,
  "active": true
}

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "id": 1,
    "sku": "APPLEIPHONE13",
    "name": "Apple Iphone 13",
    "description": "Smartphone from Apple",
    "price": 20000,
    "hsCode": "text",
    "upc": "text",
    "ean": "0194252698525",
    "guid": "text",
    "rop": 1,
    "expMethod": "FIFO",
    "originCountry": "PL",
    "scanSerialNumber": false,
    "mpn": "text",
    "isbn": "text",
    "note": "some useful information",
    "productType": "finalProduct",
    "customField1": "text",
    "customField2": "text",
    "customField3": "text",
    "ageCheck": false,
    "active": true
  }
}

Update product by sku

put

Authorizations

authorizationXApiKey

Path parameters

skustringRequired

Header parameters

x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body

skustring · min: 1RequiredExample: APPLEIPHONE13Pattern: ^[a-zA-Z0-9_*().s,+/\- ]*$

namestring · min: 1RequiredExample: Apple Iphone 13

descriptionstring · min: 1OptionalExample: Smartphone from Apple

pricenumberOptionalExample: 20000

hsCodestring · min: 1Optional

upcstring · min: 1 · max: 50Optional

eanstringOptionalExample: 0194252698525

guidstringOptional

ropnumberOptional

expMethodstring · enumRequiredExample: FIFOPossible values:

originCountrystring · min: 2 · max: 2OptionalExample: PL

scanSerialNumberbooleanOptional

mpnstring · min: 1 · max: 50Optional

isbnstring · min: 1 · max: 50Optional

notestring · min: 1 · max: 255OptionalExample: some useful information

productTypestring · enumRequiredExample: finalProductPossible values:

customField1string · min: 1 · max: 255Optional

customField2string · min: 1 · max: 255Optional

customField3string · min: 1 · max: 255Optional

ageCheckbooleanOptional

Info whether is necessary to check recipient age by delivery service

activebooleanRequiredExample: true

Responses

200

Success response

application/json

401

Unauthorized response

application/json

404

Not found response

application/json

put

HTTPcURLJavaScriptPython

PUT /v2/products/{sku} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "sku": "APPLEIPHONE13",
  "name": "Apple Iphone 13",
  "description": "Smartphone from Apple",
  "price": 20000,
  "hsCode": "text",
  "upc": "text",
  "ean": "0194252698525",
  "guid": "text",
  "rop": 1,
  "expMethod": "FIFO",
  "originCountry": "PL",
  "scanSerialNumber": false,
  "mpn": "text",
  "isbn": "text",
  "note": "some useful information",
  "productType": "finalProduct",
  "customField1": "text",
  "customField2": "text",
  "customField3": "text",
  "ageCheck": false,
  "active": true
}

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "id": 1,
    "sku": "APPLEIPHONE13",
    "name": "Apple Iphone 13",
    "description": "Smartphone from Apple",
    "price": 20000,
    "hsCode": "text",
    "upc": "text",
    "ean": "0194252698525",
    "guid": "text",
    "rop": 1,
    "expMethod": "FIFO",
    "originCountry": "PL",
    "scanSerialNumber": false,
    "mpn": "text",
    "isbn": "text",
    "note": "some useful information",
    "productType": "finalProduct",
    "customField1": "text",
    "customField2": "text",
    "customField3": "text",
    "ageCheck": false,
    "active": true
  }
}

Update product by guid

put

Authorizations

authorizationXApiKey

Path parameters

guidstringRequired

Header parameters

x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body

skustring · min: 1RequiredExample: APPLEIPHONE13Pattern: ^[a-zA-Z0-9_*().s,+/\- ]*$

namestring · min: 1RequiredExample: Apple Iphone 13

descriptionstring · min: 1OptionalExample: Smartphone from Apple

pricenumberOptionalExample: 20000

hsCodestring · min: 1Optional

upcstring · min: 1 · max: 50Optional

eanstringOptionalExample: 0194252698525

guidstringOptional

ropnumberOptional

expMethodstring · enumRequiredExample: FIFOPossible values:

originCountrystring · min: 2 · max: 2OptionalExample: PL

scanSerialNumberbooleanOptional

mpnstring · min: 1 · max: 50Optional

isbnstring · min: 1 · max: 50Optional

notestring · min: 1 · max: 255OptionalExample: some useful information

productTypestring · enumRequiredExample: finalProductPossible values:

customField1string · min: 1 · max: 255Optional

customField2string · min: 1 · max: 255Optional

customField3string · min: 1 · max: 255Optional

ageCheckbooleanOptional

Info whether is necessary to check recipient age by delivery service

activebooleanRequiredExample: true

Responses

200

Success response

application/json

401

Unauthorized response

application/json

404

Not found response

application/json

put

HTTPcURLJavaScriptPython

PUT /v2/products/guid/{guid} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 424

{
  "sku": "APPLEIPHONE13",
  "name": "Apple Iphone 13",
  "description": "Smartphone from Apple",
  "price": 20000,
  "hsCode": "text",
  "upc": "text",
  "ean": "0194252698525",
  "guid": "text",
  "rop": 1,
  "expMethod": "FIFO",
  "originCountry": "PL",
  "scanSerialNumber": false,
  "mpn": "text",
  "isbn": "text",
  "note": "some useful information",
  "productType": "finalProduct",
  "customField1": "text",
  "customField2": "text",
  "customField3": "text",
  "ageCheck": false,
  "active": true
}

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "id": 1,
    "sku": "APPLEIPHONE13",
    "name": "Apple Iphone 13",
    "description": "Smartphone from Apple",
    "price": 20000,
    "hsCode": "text",
    "upc": "text",
    "ean": "0194252698525",
    "guid": "text",
    "rop": 1,
    "expMethod": "FIFO",
    "originCountry": "PL",
    "scanSerialNumber": false,
    "mpn": "text",
    "isbn": "text",
    "note": "some useful information",
    "productType": "finalProduct",
    "customField1": "text",
    "customField2": "text",
    "customField3": "text",
    "ageCheck": false,
    "active": true
  }
}