Skip to content

Creation of shipment

Request

In the packages field, you can send an object containing three combinations of child fields:

  • orderPackagingId only,
  • packaging and weight,
  • width, height, depth, and weight.
Security
shoptetAccessToken or shoptetPrivateApiToken
Bodyapplication/json
dataobject, non-emptyrequired
curl -i -X POST \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/shipments \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "orderCode": "2024000008",
      "note": "shipment note",
      "cod": "21.00",
      "shippingId": 250,
      "addressId": 1,
      "bankAccountId": 1,
      "packages": [
        {
          "orderPackagingId": 3
        }
      ]
    }
  }'

Responses

Created

Bodyapplication/json; charset=utf-8
dataobjectrequired
errorsArray of objects or null(Errors)required
Response
{
  "data": {
    "guid": "1e3f3f32-3f3f-6766-3f3f-02423f1f0004",
    "checkUrls": [ … ]
  },
  "errors": [
    { … }
  ]
}