Skladon - Developers
  • Skladon docs
  • 馃摗Integration
    • API
      • API usage tips and limits
      • Authentication
      • Claims
      • Files
      • Orders
      • Products
      • Products availability
      • Products sets
      • Receivings
      • Returns
      • Shipper service codes
      • Webhooks
      • Stock movements
    • Webhooks
  • Report a Bug
Powered by GitBook
On this page
  1. Integration
  2. API

Receivings

PreviousProducts setsNextReturns

Last updated 4 months ago

You may find descriptions of endpoints for work with receivings bellow.

馃摗
  • POSTFilter receivings
  • GETGet receiving
  • POSTCreate receiving
  • PUTUpdate receiving

Get receiving

get
Authorizations
Path parameters
eshopReceivingIdstringRequired
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
GET /v2/receivings/{eshopReceivingId} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Accept: */*

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "eshopReceivingId": "text",
    "description": "text",
    "trackingNumber": "text",
    "supplier": "text",
    "estimatedDelivery": "2025-05-25",
    "handlingUnits": "box_loose",
    "carrierInfo": "text",
    "deliveryNoteNumber": "text",
    "deliveryType": "courier",
    "urgent": "ok",
    "duty": true,
    "unitsAmount": 1,
    "driverCompany": "text",
    "driverTrailerLicensePlate": "text",
    "driverName": "text",
    "driverPhone": "text",
    "driverDispatcherContact": "text",
    "eshopNote": "text",
    "products": [
      {
        "sku": "text",
        "quantity": 1,
        "lot": "text",
        "expirationDate": "2025-05-25",
        "productPrice": 1,
        "lineState": "E"
      }
    ],
    "packagings": [
      {
        "packagingType": "non_returnable_pallet",
        "pallet": "pallet_100x120_ippc",
        "quantity": 1
      }
    ],
    "status": "awaiting"
  }
}

Filter receivings

post
Authorizations
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
POST /v2/receivings/filter HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "page": 1,
  "items": 30,
  "columns": [
    "estimatedDelivery",
    "duty",
    "eshopReceivingId"
  ],
  "sorts": [
    {
      "column": "estimatedDelivery",
      "direction": "DESC"
    }
  ],
  "filters": [
    [
      {
        "column": "duty",
        "operator": "eq",
        "value": true
      }
    ]
  ]
}
{
  "statusCode": 200,
  "message": "text",
  "data": {
    "data": [
      {
        "eshopReceivingId": "text",
        "description": "text",
        "trackingNumber": "text",
        "supplier": "text",
        "estimatedDelivery": "2025-05-25",
        "handlingUnits": "box_loose",
        "carrierInfo": "text",
        "deliveryNoteNumber": "text",
        "deliveryType": "courier",
        "urgent": "ok",
        "duty": true,
        "unitsAmount": 1,
        "driverCompany": "text",
        "driverTrailerLicensePlate": "text",
        "driverName": "text",
        "driverPhone": "text",
        "driverDispatcherContact": "text",
        "eshopNote": "text"
      }
    ],
    "request": {
      "page": 1,
      "items": 30,
      "columns": [
        "estimatedDelivery",
        "duty",
        "eshopReceivingId"
      ],
      "sorts": [
        {
          "column": "estimatedDelivery",
          "direction": "DESC"
        }
      ],
      "filters": [
        [
          {
            "column": "duty",
            "operator": "eq",
            "value": true
          }
        ]
      ]
    },
    "totalCount": 430
  }
}

Create receiving

post
Authorizations
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body
eshopReceivingIdstring 路 min: 1Required
descriptionstring 路 min: 1Optional
trackingNumberstring 路 min: 1Optional
supplierstring 路 min: 1Optional
estimatedDeliverystring 路 dateRequired
handlingUnitsstring 路 enumRequiredPossible values:
carrierInfostring 路 min: 1Optional
deliveryNoteNumberstring 路 min: 1Optional
deliveryTypestring 路 enumOptionalPossible values:
urgentstring 路 enumOptionalPossible values:
dutybooleanOptional
unitsAmountnumber 路 min: 1Required
driverCompanystringOptional
driverTrailerLicensePlatestringOptional
driverNamestringOptional
driverPhonestringOptional
driverDispatcherContactstringOptional
eshopNotestringOptional
Responses
200
Success response
application/json
401
Unauthorized response
application/json
409
Conflict response
application/json
post
POST /v2/receivings HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 636

{
  "eshopReceivingId": "text",
  "description": "text",
  "trackingNumber": "text",
  "supplier": "text",
  "estimatedDelivery": "2025-05-25",
  "handlingUnits": "box_loose",
  "carrierInfo": "text",
  "deliveryNoteNumber": "text",
  "deliveryType": "courier",
  "urgent": "ok",
  "duty": true,
  "unitsAmount": 1,
  "driverCompany": "text",
  "driverTrailerLicensePlate": "text",
  "driverName": "text",
  "driverPhone": "text",
  "driverDispatcherContact": "text",
  "eshopNote": "text",
  "products": [
    {
      "sku": "text",
      "quantity": 1,
      "lot": "text",
      "expirationDate": "2025-05-25",
      "productPrice": 1,
      "lineState": "E"
    }
  ],
  "packagings": [
    {
      "packagingType": "non_returnable_pallet",
      "pallet": "pallet_100x120_ippc",
      "quantity": 1
    }
  ]
}
{
  "statusCode": 200,
  "message": "text",
  "data": {
    "eshopReceivingId": "text",
    "description": "text",
    "trackingNumber": "text",
    "supplier": "text",
    "estimatedDelivery": "2025-05-25",
    "handlingUnits": "box_loose",
    "carrierInfo": "text",
    "deliveryNoteNumber": "text",
    "deliveryType": "courier",
    "urgent": "ok",
    "duty": true,
    "unitsAmount": 1,
    "driverCompany": "text",
    "driverTrailerLicensePlate": "text",
    "driverName": "text",
    "driverPhone": "text",
    "driverDispatcherContact": "text",
    "eshopNote": "text",
    "products": [
      {
        "sku": "text",
        "quantity": 1,
        "lot": "text",
        "expirationDate": "2025-05-25",
        "productPrice": 1,
        "lineState": "E"
      }
    ],
    "packagings": [
      {
        "packagingType": "non_returnable_pallet",
        "pallet": "pallet_100x120_ippc",
        "quantity": 1
      }
    ],
    "status": "awaiting"
  }
}

Update receiving

put
Authorizations
Path parameters
eshopReceivingIdstringRequired
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body
eshopReceivingIdstring 路 min: 1Required
descriptionstring 路 min: 1Optional
trackingNumberstring 路 min: 1Optional
supplierstring 路 min: 1Optional
estimatedDeliverystring 路 dateRequired
handlingUnitsstring 路 enumRequiredPossible values:
carrierInfostring 路 min: 1Optional
deliveryNoteNumberstring 路 min: 1Optional
deliveryTypestring 路 enumOptionalPossible values:
urgentstring 路 enumOptionalPossible values:
dutybooleanOptional
unitsAmountnumber 路 min: 1Required
driverCompanystringOptional
driverTrailerLicensePlatestringOptional
driverNamestringOptional
driverPhonestringOptional
driverDispatcherContactstringOptional
eshopNotestringOptional
statusstring 路 enumOptionalPossible values:
Responses
200
Success response
application/json
401
Unauthorized response
application/json
404
Not found response
application/json
put
PUT /v2/receivings/{eshopReceivingId} HTTP/1.1
Host: gw.new.skladon.net
authorization: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 656

{
  "eshopReceivingId": "text",
  "description": "text",
  "trackingNumber": "text",
  "supplier": "text",
  "estimatedDelivery": "2025-05-25",
  "handlingUnits": "box_loose",
  "carrierInfo": "text",
  "deliveryNoteNumber": "text",
  "deliveryType": "courier",
  "urgent": "ok",
  "duty": true,
  "unitsAmount": 1,
  "driverCompany": "text",
  "driverTrailerLicensePlate": "text",
  "driverName": "text",
  "driverPhone": "text",
  "driverDispatcherContact": "text",
  "eshopNote": "text",
  "products": [
    {
      "sku": "text",
      "quantity": 1,
      "lot": "text",
      "expirationDate": "2025-05-25",
      "productPrice": 1,
      "lineState": "E"
    }
  ],
  "packagings": [
    {
      "packagingType": "non_returnable_pallet",
      "pallet": "pallet_100x120_ippc",
      "quantity": 1
    }
  ],
  "status": "canceled"
}
{
  "statusCode": 200,
  "message": "text",
  "data": {
    "eshopReceivingId": "text",
    "description": "text",
    "trackingNumber": "text",
    "supplier": "text",
    "estimatedDelivery": "2025-05-25",
    "handlingUnits": "box_loose",
    "carrierInfo": "text",
    "deliveryNoteNumber": "text",
    "deliveryType": "courier",
    "urgent": "ok",
    "duty": true,
    "unitsAmount": 1,
    "driverCompany": "text",
    "driverTrailerLicensePlate": "text",
    "driverName": "text",
    "driverPhone": "text",
    "driverDispatcherContact": "text",
    "eshopNote": "text",
    "products": [
      {
        "sku": "text",
        "quantity": 1,
        "lot": "text",
        "expirationDate": "2025-05-25",
        "productPrice": 1,
        "lineState": "E"
      }
    ],
    "packagings": [
      {
        "packagingType": "non_returnable_pallet",
        "pallet": "pallet_100x120_ippc",
        "quantity": 1
      }
    ],
    "status": "awaiting"
  }
}