Orders

Filter orders

post

Authorizations

authorizationstringRequired

x-api-keystringRequired

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

columnsarray · enumOptional

List of columns you want to retrieve. If empty, all possible columns will be retrieved

Example: ["id","status","timestamp"]Possible values:

Responses

200

Success response

application/json

401

Unauthorized response

application/json

post

/orders/filter

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

{
  "page": 1,
  "items": 30,
  "columns": [
    "id",
    "status",
    "timestamp"
  ],
  "sorts": [
    {
      "column": "timestamp",
      "direction": "DESC"
    }
  ],
  "filters": [
    [
      {
        "column": "shipper",
        "operator": "eq",
        "value": [
          "CP",
          "UPS"
        ]
      }
    ]
  ]
}

{
  "statusCode": 200,
  "message": "text",
  "data": [
    {
      "id": 1,
      "status": "inProcess",
      "timestamp": "2022-05-23T18:43:10.000Z",
      "updatedAt": "2022-05-23T18:43:10.000Z",
      "deliveredAt": "2022-05-23T18:43:10.000Z",
      "canceledAt": "2022-05-23T18:43:10.000Z",
      "trackingNumbers": [
        "012364479"
      ],
      "eshopOrderId": "12345",
      "invoiceNumber": "4790712402150",
      "orderType": "b2c",
      "invoiceDate": "2022-05-23T18:43:10.000Z",
      "requiredExpeditionDate": "2022-05-23T18:43:10.000Z",
      "partnerOrderId": "text",
      "recipientName": "Jan Novák",
      "recipientAttentionName": "Jan Novák",
      "recipientEmail": "[email protected]",
      "recipientPhone": "735001002",
      "recipientCompanyName": "text",
      "recipientCompanyId": "text",
      "recipientTaxId": "text",
      "recipientStreet": "Komenského 172",
      "recipientAddressAdditionalInfo": "text",
      "recipientCity": "Praha",
      "recipientState": "CZ",
      "recipientProvinceCode": "text",
      "recipientPostCode": "70316",
      "recipientGln": "01234563987",
      "billingName": "Jan Novák",
      "billingAttentionName": "Jan Novák",
      "billingEmail": "[email protected]",
      "billingPhone": "735001002",
      "billingCompanyName": "text",
      "billingCompanyId": "text",
      "billingTaxId": "text",
      "billingStreet": "Komenského 172",
      "billingAddressAdditionalInfo": "text",
      "billingCity": "Praha",
      "billingState": "CZ",
      "billingProvinceCode": "text",
      "billingPostCode": "70316",
      "billingGln": "9874563210",
      "shipper": "text",
      "addressId": "CZ12345",
      "message": "text",
      "paid": true,
      "paymentMethod": "0",
      "price": 2990,
      "currency": "CZK",
      "shippingPrice": 0,
      "codPrice": 2990,
      "codCurrency": "CZK",
      "codRefNumber": 10898,
      "note": "text",
      "shipperServiceCode": "text",
      "allowExpedition": true,
      "printReturnLabel": true,
      "printFiles": true,
      "holdByQuality": true,
      "disableShippingReorder": true,
      "marketplace": "alza",
      "underSanction": true,
      "priority": 0,
      "waitingForPaymentAt": "2023-10-01T12:00:00Z",
      "productsNotAvailableAt": "2023-10-02T12:00:00Z",
      "suspendedAt": "2023-10-03T12:00:00Z",
      "releaseFromSuspendedAt": "2023-10-04T12:00:00Z",
      "incorrectAt": "2023-10-05T12:00:00Z",
      "waitingForShipmentAt": "2023-10-06T12:00:00Z",
      "shipmentOrderedAt": "2023-10-07T12:00:00Z",
      "inProcessAt": "2023-10-08T12:00:00Z",
      "packedAt": "2023-10-09T12:00:00Z",
      "waitingForCarrierAt": "2023-10-10T12:00:00Z",
      "shippedAt": "2023-10-11T12:00:00Z",
      "returningBackAt": "2023-10-12T12:00:00Z",
      "parentOrderId": 12345,
      "parentEshopOrderId": "ESHOP12345",
      "returnTrackingNumber": "TRACK12345",
      "eshopNote": "Order note",
      "orderBoxCount": 2,
      "incorrectOrderMessage": "The order is incorrect"
    }
  ],
  "request": {
    "page": 1,
    "items": 30,
    "columns": [
      "id",
      "status",
      "timestamp"
    ],
    "sorts": [
      {
        "column": "timestamp",
        "direction": "DESC"
      }
    ],
    "filters": [
      [
        {
          "column": "shipper",
          "operator": "eq",
          "value": [
            "CP",
            "UPS"
          ]
        }
      ]
    ]
  },
  "totalCount": 430
}

Get order detail

get

Authorizations

authorizationstringRequired

x-api-keystringRequired

Path parameters

eshopOrderIdstringRequired

Query parameters

withPackingListsbooleanOptional

If turned on it returns information what SKUs are in which packing together with SSCC codes, serial numbers etc.

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

/orders/{eshopOrderId}

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

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "id": 1,
    "status": "inProcess",
    "timestamp": "2022-05-23T18:43:10.000Z",
    "updatedAt": "2022-05-23T18:43:10.000Z",
    "deliveredAt": "2022-05-23T18:43:10.000Z",
    "canceledAt": "2022-05-23T18:43:10.000Z",
    "trackingNumbers": [
      "012364479"
    ],
    "eshopOrderId": "12345",
    "invoiceNumber": "4790712402150",
    "orderType": "b2c",
    "invoiceDate": "2022-05-23T18:43:10.000Z",
    "requiredExpeditionDate": "2022-05-23T18:43:10.000Z",
    "partnerOrderId": "text",
    "recipientName": "Jan Novák",
    "recipientAttentionName": "Jan Novák",
    "recipientEmail": "[email protected]",
    "recipientPhone": "735001002",
    "recipientCompanyName": "text",
    "recipientCompanyId": "text",
    "recipientTaxId": "text",
    "recipientStreet": "Komenského 172",
    "recipientAddressAdditionalInfo": "text",
    "recipientCity": "Praha",
    "recipientState": "CZ",
    "recipientProvinceCode": "text",
    "recipientPostCode": "70316",
    "recipientGln": "01234563987",
    "billingName": "Jan Novák",
    "billingAttentionName": "Jan Novák",
    "billingEmail": "[email protected]",
    "billingPhone": "735001002",
    "billingCompanyName": "text",
    "billingCompanyId": "text",
    "billingTaxId": "text",
    "billingStreet": "Komenského 172",
    "billingAddressAdditionalInfo": "text",
    "billingCity": "Praha",
    "billingState": "CZ",
    "billingProvinceCode": "text",
    "billingPostCode": "70316",
    "billingGln": "9874563210",
    "shipper": "text",
    "addressId": "CZ12345",
    "message": "text",
    "paid": true,
    "paymentMethod": "0",
    "price": 2990,
    "currency": "CZK",
    "shippingPrice": 0,
    "codPrice": 2990,
    "codCurrency": "CZK",
    "codRefNumber": 10898,
    "note": "text",
    "shipperServiceCode": "text",
    "allowExpedition": true,
    "printReturnLabel": true,
    "printFiles": true,
    "holdByQuality": true,
    "disableShippingReorder": true,
    "marketplace": "alza",
    "underSanction": true,
    "priority": 0,
    "waitingForPaymentAt": "2023-10-01T12:00:00Z",
    "productsNotAvailableAt": "2023-10-02T12:00:00Z",
    "suspendedAt": "2023-10-03T12:00:00Z",
    "releaseFromSuspendedAt": "2023-10-04T12:00:00Z",
    "incorrectAt": "2023-10-05T12:00:00Z",
    "waitingForShipmentAt": "2023-10-06T12:00:00Z",
    "shipmentOrderedAt": "2023-10-07T12:00:00Z",
    "inProcessAt": "2023-10-08T12:00:00Z",
    "packedAt": "2023-10-09T12:00:00Z",
    "waitingForCarrierAt": "2023-10-10T12:00:00Z",
    "shippedAt": "2023-10-11T12:00:00Z",
    "returningBackAt": "2023-10-12T12:00:00Z",
    "parentOrderId": 12345,
    "parentEshopOrderId": "ESHOP12345",
    "returnTrackingNumber": "TRACK12345",
    "eshopNote": "Order note",
    "orderBoxCount": 2,
    "incorrectOrderMessage": "The order is incorrect",
    "orderProducts": [
      {
        "sku": "SKU1",
        "productPrice": 2000,
        "count": 1,
        "lot": "text",
        "serialNumbers": [
          "012364479"
        ],
        "customsProductType": "saleOfGoods",
        "lineState": "E",
        "customizationType": "engraving",
        "packingLists": [
          {
            "id": 1,
            "expeditionPalletNumber": "1235458789",
            "expeditionBoxNumber": "98745698",
            "ssccCode": "87445987445",
            "serialNumbers": [
              "4566897445621"
            ],
            "lots": [
              "LOT123"
            ],
            "expDates": [
              "2024-12-31"
            ],
            "count": 20
          }
        ],
        "customizationText": "PJ",
        "bcxCodes": [
          "text"
        ],
        "eshopOrderProductId": "clientEshopOrderProductId1",
        "orderProductFiles": [
          {
            "type": "other",
            "fileName": "123456.PDF",
            "fileType": "PDF",
            "fileSize": "text",
            "id": 1
          }
        ]
      }
    ],
    "orderFiles": [
      {
        "type": "invoice",
        "fileName": "123456.PDF",
        "fileType": "PDF",
        "fileSize": "text",
        "id": 1
      }
    ]
  }
}

Create new order

post

Authorizations

authorizationstringRequired

x-api-keystringRequired

Header parameters

x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body

eshopOrderIdstringRequired

Unique order ID from the e-shop. Used to check whether the order has not already been created in MySkladon. The ideal value is the unique order identifier from the e-shop.

Example: 12345

invoiceNumberstringOptionalExample: 4790712402150

orderTypestring · enumRequiredExample: b2cPossible values:

statusstring · enumOptional

Optional initial status. Allowed values are preReceived (default) or preOrder. preReceived is the normal default status, preOrder is for pre-orders that should not be picked yet.

Example: preReceivedPossible values:

invoiceDatestringOptionalExample: 2022-05-23 20:39:38

requiredExpeditionDatestringOptional

Required expedition date for B2B orders

Example: 2022-05-23 20:39:38

partnerOrderIdstringOptional

recipientNamestringOptionalExample: Jan Novák

recipientAttentionNamestringOptionalExample: Jan Novák

recipientEmailstringOptionalExample: [email protected]

recipientPhonestringOptionalExample: 735001002

recipientCompanyNamestringOptional

recipientCompanyIdstringOptional

Must be filled for transfer order type. Value can be found in MYS at Settings -> Provider transfer companies

recipientTaxIdstringOptional

recipientStreetstringOptionalExample: Komenského 172

recipientAddressAdditionalInfostringOptional

recipientCitystringOptionalExample: Praha

recipientStatestringOptional

https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes (Alpha-2 code)

Example: CZ

recipientProvinceCodestringOptional

recipientPostCodestringOptionalExample: 70316

recipientGlnstringOptionalExample: 01234563987

billingNamestringOptionalExample: Jan Novák

billingAttentionNamestringOptionalExample: Jan Novák

billingEmailstringOptionalExample: [email protected]

billingPhonestringOptionalExample: 735001002

billingCompanyNamestringOptional

billingCompanyIdstringOptional

billingTaxIdstringOptional

billingStreetstringOptionalExample: Komenského 172

billingAddressAdditionalInfostringOptional

billingCitystringOptionalExample: Praha

billingStatestringOptional

https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes (Alpha-2 code)

Example: CZ

billingProvinceCodestringOptional

billingPostCodestringOptionalExample: 70316

billingGlnstringOptionalExample: 9874563210

shipperstringOptional

Use the 'shipper' field obtained from GET /v2/shipper-service-codes endpoint

addressIdstringOptional

ID of carrier's pickup point

Example: CZ12345

messagestringOptional

paidbooleanOptional

True if order is paid, false otherwise.

Example: true

paymentMethodstring · enumOptional

0 - cash on delivery, 1 - card online, 2 - bank transfer

Possible values:

pricenumberOptionalExample: 2990

currencystringOptional

https://en.wikipedia.org/wiki/ISO_4217

Example: CZK

shippingPricenumberOptional

codPricenumberOptionalExample: 2990

codCurrencystringOptional

https://en.wikipedia.org/wiki/ISO_4217

Example: CZK

codRefNumberstring · min: 1OptionalExample: 10898

notestringOptional

eshopNotestringOptional

Note from e-shop that is not shown to the customer

shipperServiceCodestringOptional

Use the 'value' field obtained from GET /v2/shipper-service-codes endpoint

allowExpeditionbooleanOptionalDefault: true

printReturnLabelbooleanOptional

printFilesbooleanOptional

If true order file with "invoice" type will be printed

holdByQualitybooleanOptional

If true order will be picked from quality

trackingNumbersstring[]Optional

Tracking numbers

underSanctionbooleanOptional

If set to true, order is marked as under sanction. Only for B2B orders.

prioritynumber · enumOptional

Order priority. 0 - normal, 1 - high

Default: 0Possible values:

disableShippingReorderbooleanOptional

If set to true, standard shipping wont be ordered. It is necessary to pass shippingAddonLabel to order files and set value for marketplace.

marketplacestring · enumOptional

Order marketplace origin. Required if disableShippingReorder is set to true.

Example: alzaPossible values:

Responses

200

Success response

application/json

401

Unauthorized response

application/json

409

Conflict response

application/json

post

/orders

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

{
  "eshopOrderId": "12345",
  "invoiceNumber": "4790712402150",
  "orderType": "b2c",
  "status": "preReceived",
  "invoiceDate": "2022-05-23 20:39:38",
  "requiredExpeditionDate": "2022-05-23 20:39:38",
  "partnerOrderId": "text",
  "recipientName": "Jan Novák",
  "recipientAttentionName": "Jan Novák",
  "recipientEmail": "[email protected]",
  "recipientPhone": "735001002",
  "recipientCompanyName": "text",
  "recipientCompanyId": "text",
  "recipientTaxId": "text",
  "recipientStreet": "Komenského 172",
  "recipientAddressAdditionalInfo": "text",
  "recipientCity": "Praha",
  "recipientState": "CZ",
  "recipientProvinceCode": "text",
  "recipientPostCode": "70316",
  "recipientGln": "01234563987",
  "billingName": "Jan Novák",
  "billingAttentionName": "Jan Novák",
  "billingEmail": "[email protected]",
  "billingPhone": "735001002",
  "billingCompanyName": "text",
  "billingCompanyId": "text",
  "billingTaxId": "text",
  "billingStreet": "Komenského 172",
  "billingAddressAdditionalInfo": "text",
  "billingCity": "Praha",
  "billingState": "CZ",
  "billingProvinceCode": "text",
  "billingPostCode": "70316",
  "billingGln": "9874563210",
  "shipper": "text",
  "addressId": "CZ12345",
  "message": "text",
  "paid": true,
  "paymentMethod": "0",
  "price": 2990,
  "currency": "CZK",
  "shippingPrice": 0,
  "codPrice": 2990,
  "codCurrency": "CZK",
  "codRefNumber": 10898,
  "note": "text",
  "eshopNote": "text",
  "shipperServiceCode": "text",
  "allowExpedition": true,
  "printReturnLabel": true,
  "printFiles": true,
  "holdByQuality": true,
  "trackingNumbers": [
    "012364479"
  ],
  "underSanction": true,
  "priority": 0,
  "disableShippingReorder": true,
  "marketplace": "alza",
  "orderProducts": [
    {
      "sku": "SKU1",
      "productPrice": 2000,
      "count": 1,
      "locationId": "text",
      "lot": "text",
      "customsProductType": "saleOfGoods",
      "lineState": "E",
      "customizationType": "engraving",
      "customizationText": "text",
      "eshopOrderProductId": "text",
      "bcxCodes": [
        "text"
      ],
      "orderProductFiles": [
        {
          "type": "other",
          "data": "someBase64",
          "fileName": "123456.PDF",
          "fileType": "PDF",
          "fileSize": "text",
          "id": 1
        }
      ]
    }
  ],
  "orderFiles": [
    {
      "type": "invoice",
      "data": "someBase64",
      "fileName": "123456.PDF",
      "fileType": "PDF",
      "fileSize": "text"
    }
  ]
}

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "id": 1,
    "status": "inProcess",
    "timestamp": "2022-05-23T18:43:10.000Z",
    "updatedAt": "2022-05-23T18:43:10.000Z",
    "deliveredAt": "2022-05-23T18:43:10.000Z",
    "canceledAt": "2022-05-23T18:43:10.000Z",
    "trackingNumbers": [
      "012364479"
    ],
    "eshopOrderId": "12345",
    "invoiceNumber": "4790712402150",
    "orderType": "b2c",
    "invoiceDate": "2022-05-23T18:43:10.000Z",
    "requiredExpeditionDate": "2022-05-23T18:43:10.000Z",
    "partnerOrderId": "text",
    "recipientName": "Jan Novák",
    "recipientAttentionName": "Jan Novák",
    "recipientEmail": "[email protected]",
    "recipientPhone": "735001002",
    "recipientCompanyName": "text",
    "recipientCompanyId": "text",
    "recipientTaxId": "text",
    "recipientStreet": "Komenského 172",
    "recipientAddressAdditionalInfo": "text",
    "recipientCity": "Praha",
    "recipientState": "CZ",
    "recipientProvinceCode": "text",
    "recipientPostCode": "70316",
    "recipientGln": "01234563987",
    "billingName": "Jan Novák",
    "billingAttentionName": "Jan Novák",
    "billingEmail": "[email protected]",
    "billingPhone": "735001002",
    "billingCompanyName": "text",
    "billingCompanyId": "text",
    "billingTaxId": "text",
    "billingStreet": "Komenského 172",
    "billingAddressAdditionalInfo": "text",
    "billingCity": "Praha",
    "billingState": "CZ",
    "billingProvinceCode": "text",
    "billingPostCode": "70316",
    "billingGln": "9874563210",
    "shipper": "text",
    "addressId": "CZ12345",
    "message": "text",
    "paid": true,
    "paymentMethod": "0",
    "price": 2990,
    "currency": "CZK",
    "shippingPrice": 0,
    "codPrice": 2990,
    "codCurrency": "CZK",
    "codRefNumber": 10898,
    "note": "text",
    "shipperServiceCode": "text",
    "allowExpedition": true,
    "printReturnLabel": true,
    "printFiles": true,
    "holdByQuality": true,
    "disableShippingReorder": true,
    "marketplace": "alza",
    "underSanction": true,
    "priority": 0,
    "waitingForPaymentAt": "2023-10-01T12:00:00Z",
    "productsNotAvailableAt": "2023-10-02T12:00:00Z",
    "suspendedAt": "2023-10-03T12:00:00Z",
    "releaseFromSuspendedAt": "2023-10-04T12:00:00Z",
    "incorrectAt": "2023-10-05T12:00:00Z",
    "waitingForShipmentAt": "2023-10-06T12:00:00Z",
    "shipmentOrderedAt": "2023-10-07T12:00:00Z",
    "inProcessAt": "2023-10-08T12:00:00Z",
    "packedAt": "2023-10-09T12:00:00Z",
    "waitingForCarrierAt": "2023-10-10T12:00:00Z",
    "shippedAt": "2023-10-11T12:00:00Z",
    "returningBackAt": "2023-10-12T12:00:00Z",
    "parentOrderId": 12345,
    "parentEshopOrderId": "ESHOP12345",
    "returnTrackingNumber": "TRACK12345",
    "eshopNote": "Order note",
    "orderBoxCount": 2,
    "incorrectOrderMessage": "The order is incorrect",
    "orderProducts": [
      {
        "sku": "SKU1",
        "productPrice": 2000,
        "count": 1,
        "lot": "text",
        "serialNumbers": [
          "012364479"
        ],
        "customsProductType": "saleOfGoods",
        "lineState": "E",
        "customizationType": "engraving",
        "packingLists": [
          {
            "id": 1,
            "expeditionPalletNumber": "1235458789",
            "expeditionBoxNumber": "98745698",
            "ssccCode": "87445987445",
            "serialNumbers": [
              "4566897445621"
            ],
            "lots": [
              "LOT123"
            ],
            "expDates": [
              "2024-12-31"
            ],
            "count": 20
          }
        ],
        "customizationText": "PJ",
        "bcxCodes": [
          "text"
        ],
        "eshopOrderProductId": "clientEshopOrderProductId1",
        "orderProductFiles": [
          {
            "type": "other",
            "fileName": "123456.PDF",
            "fileType": "PDF",
            "fileSize": "text",
            "id": 1
          }
        ]
      }
    ],
    "orderFiles": [
      {
        "type": "invoice",
        "fileName": "123456.PDF",
        "fileType": "PDF",
        "fileSize": "text",
        "id": 1
      }
    ]
  }
}

Updates order

put

Authorizations

authorizationstringRequired

x-api-keystringRequired

Path parameters

eshopOrderIdstringRequired

Header parameters

x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body

eshopOrderIdstringRequired

Unique order ID from the e-shop. Used to check whether the order has not already been created in MySkladon. The ideal value is the unique order identifier from the e-shop.

Example: 12345

invoiceNumberstringOptionalExample: 4790712402150

orderTypestring · enumRequiredExample: b2cPossible values:

invoiceDatestringOptionalExample: 2022-05-23 20:39:38

requiredExpeditionDatestringOptional

Required expedition date for B2B orders.

Example: 2022-05-23 20:39:38

partnerOrderIdstringOptional

recipientNamestringOptionalExample: Jan Novák

recipientAttentionNamestringOptionalExample: Jan Novák

recipientEmailstringOptionalExample: [email protected]

recipientPhonestringOptionalExample: 735001002

recipientCompanyNamestringOptional

recipientCompanyIdstringOptional

Must be filled for transfer order type. Value can be found in MYS at Settings -> Provider transfer companies

recipientTaxIdstringOptional

recipientStreetstringOptionalExample: Komenského 172

recipientAddressAdditionalInfostringOptional

recipientCitystringOptionalExample: Praha

recipientStatestringOptional

https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes (Alpha-2 code)

Example: CZ

recipientProvinceCodestringOptional

recipientPostCodestringOptionalExample: 70316

recipientGlnstringOptionalExample: 01234563987

billingNamestringOptionalExample: Jan Novák

billingAttentionNamestringOptionalExample: Jan Novák

billingEmailstringOptionalExample: [email protected]

billingPhonestringOptionalExample: 735001002

billingCompanyNamestringOptional

billingCompanyIdstringOptional

billingTaxIdstringOptional

billingStreetstringOptionalExample: Komenského 172

billingAddressAdditionalInfostringOptional

billingCitystringOptionalExample: Praha

billingStatestringOptional

https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes (Alpha-2 code)

Example: CZ

billingProvinceCodestringOptional

billingPostCodestringOptionalExample: 70316

billingGlnstringOptionalExample: 9874563210

shipperstringOptional

Use the 'shipper' field obtained from GET /v2/shipper-service-codes endpoint

addressIdstringOptional

ID of carrier's pickup point

Example: CZ12345

messagestringOptional

paidbooleanOptional

True if order is paid, false otherwise.

Example: true

paymentMethodstring · enumOptional

0 - cash on delivery, 1 - card online, 2 - bank transfer

Possible values:

pricenumberOptionalExample: 2990

currencystringOptional

https://en.wikipedia.org/wiki/ISO_4217

Example: CZK

shippingPricenumberOptional

codPricenumberOptionalExample: 2990

codCurrencystringOptional

https://en.wikipedia.org/wiki/ISO_4217

Example: CZK

codRefNumberstring · min: 1OptionalExample: 10898

notestringOptional

eshopNotestringOptional

Note from e-shop that is not shown to the customer

shipperServiceCodestringOptional

Use the 'value' field obtained from GET /v2/shipper-service-codes endpoint

allowExpeditionbooleanOptionalDefault: true

printReturnLabelbooleanOptional

printFilesbooleanOptional

If true order file with "invoice" type will be printed

holdByQualitybooleanOptional

If true order will be picked from quality

trackingNumbersstring[]Optional

underSanctionbooleanOptional

If set to true, order is marked as under sanction. Only for B2B orders.

prioritynumber · enumOptional

Order priority. 0 - normal, 1 - high

Default: 0Possible values:

statusstring · enumOptionalPossible values:

Responses

200

Success response

application/json

401

Unauthorized response

application/json

404

Not found response

application/json

put

/orders/{eshopOrderId}

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

{
  "eshopOrderId": "12345",
  "invoiceNumber": "4790712402150",
  "orderType": "b2c",
  "invoiceDate": "2022-05-23 20:39:38",
  "requiredExpeditionDate": "2022-05-23 20:39:38",
  "partnerOrderId": "text",
  "recipientName": "Jan Novák",
  "recipientAttentionName": "Jan Novák",
  "recipientEmail": "[email protected]",
  "recipientPhone": "735001002",
  "recipientCompanyName": "text",
  "recipientCompanyId": "text",
  "recipientTaxId": "text",
  "recipientStreet": "Komenského 172",
  "recipientAddressAdditionalInfo": "text",
  "recipientCity": "Praha",
  "recipientState": "CZ",
  "recipientProvinceCode": "text",
  "recipientPostCode": "70316",
  "recipientGln": "01234563987",
  "billingName": "Jan Novák",
  "billingAttentionName": "Jan Novák",
  "billingEmail": "[email protected]",
  "billingPhone": "735001002",
  "billingCompanyName": "text",
  "billingCompanyId": "text",
  "billingTaxId": "text",
  "billingStreet": "Komenského 172",
  "billingAddressAdditionalInfo": "text",
  "billingCity": "Praha",
  "billingState": "CZ",
  "billingProvinceCode": "text",
  "billingPostCode": "70316",
  "billingGln": "9874563210",
  "shipper": "text",
  "addressId": "CZ12345",
  "message": "text",
  "paid": true,
  "paymentMethod": "0",
  "price": 2990,
  "currency": "CZK",
  "shippingPrice": 0,
  "codPrice": 2990,
  "codCurrency": "CZK",
  "codRefNumber": 10898,
  "note": "text",
  "eshopNote": "text",
  "shipperServiceCode": "text",
  "allowExpedition": true,
  "printReturnLabel": true,
  "printFiles": true,
  "holdByQuality": true,
  "trackingNumbers": [
    "012364479"
  ],
  "underSanction": true,
  "priority": 0,
  "orderProducts": [
    {
      "sku": "SKU1",
      "productPrice": 2000,
      "count": 1,
      "locationId": "text",
      "lot": "text",
      "customsProductType": "saleOfGoods",
      "lineState": "E",
      "customizationType": "engraving",
      "customizationText": "text",
      "eshopOrderProductId": "text",
      "bcxCodes": [
        "text"
      ],
      "orderProductFiles": [
        {
          "type": "other",
          "data": "someBase64",
          "fileName": "123456.PDF",
          "fileType": "PDF",
          "fileSize": "text",
          "id": 1
        }
      ]
    }
  ],
  "orderFiles": [
    {
      "type": "invoice",
      "data": "someBase64",
      "fileName": "123456.PDF",
      "fileType": "PDF",
      "fileSize": "text",
      "id": 1
    }
  ],
  "status": "preOrder"
}

{
  "statusCode": 200,
  "message": "text",
  "data": {
    "id": 1,
    "status": "inProcess",
    "timestamp": "2022-05-23T18:43:10.000Z",
    "updatedAt": "2022-05-23T18:43:10.000Z",
    "deliveredAt": "2022-05-23T18:43:10.000Z",
    "canceledAt": "2022-05-23T18:43:10.000Z",
    "trackingNumbers": [
      "012364479"
    ],
    "eshopOrderId": "12345",
    "invoiceNumber": "4790712402150",
    "orderType": "b2c",
    "invoiceDate": "2022-05-23T18:43:10.000Z",
    "requiredExpeditionDate": "2022-05-23T18:43:10.000Z",
    "partnerOrderId": "text",
    "recipientName": "Jan Novák",
    "recipientAttentionName": "Jan Novák",
    "recipientEmail": "[email protected]",
    "recipientPhone": "735001002",
    "recipientCompanyName": "text",
    "recipientCompanyId": "text",
    "recipientTaxId": "text",
    "recipientStreet": "Komenského 172",
    "recipientAddressAdditionalInfo": "text",
    "recipientCity": "Praha",
    "recipientState": "CZ",
    "recipientProvinceCode": "text",
    "recipientPostCode": "70316",
    "recipientGln": "01234563987",
    "billingName": "Jan Novák",
    "billingAttentionName": "Jan Novák",
    "billingEmail": "[email protected]",
    "billingPhone": "735001002",
    "billingCompanyName": "text",
    "billingCompanyId": "text",
    "billingTaxId": "text",
    "billingStreet": "Komenského 172",
    "billingAddressAdditionalInfo": "text",
    "billingCity": "Praha",
    "billingState": "CZ",
    "billingProvinceCode": "text",
    "billingPostCode": "70316",
    "billingGln": "9874563210",
    "shipper": "text",
    "addressId": "CZ12345",
    "message": "text",
    "paid": true,
    "paymentMethod": "0",
    "price": 2990,
    "currency": "CZK",
    "shippingPrice": 0,
    "codPrice": 2990,
    "codCurrency": "CZK",
    "codRefNumber": 10898,
    "note": "text",
    "shipperServiceCode": "text",
    "allowExpedition": true,
    "printReturnLabel": true,
    "printFiles": true,
    "holdByQuality": true,
    "disableShippingReorder": true,
    "marketplace": "alza",
    "underSanction": true,
    "priority": 0,
    "waitingForPaymentAt": "2023-10-01T12:00:00Z",
    "productsNotAvailableAt": "2023-10-02T12:00:00Z",
    "suspendedAt": "2023-10-03T12:00:00Z",
    "releaseFromSuspendedAt": "2023-10-04T12:00:00Z",
    "incorrectAt": "2023-10-05T12:00:00Z",
    "waitingForShipmentAt": "2023-10-06T12:00:00Z",
    "shipmentOrderedAt": "2023-10-07T12:00:00Z",
    "inProcessAt": "2023-10-08T12:00:00Z",
    "packedAt": "2023-10-09T12:00:00Z",
    "waitingForCarrierAt": "2023-10-10T12:00:00Z",
    "shippedAt": "2023-10-11T12:00:00Z",
    "returningBackAt": "2023-10-12T12:00:00Z",
    "parentOrderId": 12345,
    "parentEshopOrderId": "ESHOP12345",
    "returnTrackingNumber": "TRACK12345",
    "eshopNote": "Order note",
    "orderBoxCount": 2,
    "incorrectOrderMessage": "The order is incorrect",
    "orderProducts": [
      {
        "sku": "SKU1",
        "productPrice": 2000,
        "count": 1,
        "lot": "text",
        "serialNumbers": [
          "012364479"
        ],
        "customsProductType": "saleOfGoods",
        "lineState": "E",
        "customizationType": "engraving",
        "packingLists": [
          {
            "id": 1,
            "expeditionPalletNumber": "1235458789",
            "expeditionBoxNumber": "98745698",
            "ssccCode": "87445987445",
            "serialNumbers": [
              "4566897445621"
            ],
            "lots": [
              "LOT123"
            ],
            "expDates": [
              "2024-12-31"
            ],
            "count": 20
          }
        ],
        "customizationText": "PJ",
        "bcxCodes": [
          "text"
        ],
        "eshopOrderProductId": "clientEshopOrderProductId1",
        "orderProductFiles": [
          {
            "type": "other",
            "fileName": "123456.PDF",
            "fileType": "PDF",
            "fileSize": "text",
            "id": 1
          }
        ]
      }
    ],
    "orderFiles": [
      {
        "type": "invoice",
        "fileName": "123456.PDF",
        "fileType": "PDF",
        "fileSize": "text",
        "id": 1
      }
    ]
  }
}

PreviousFiles NextProducts

Last updated 7 months ago