API Documentation V1 (switch to V2)

The current "TOKEN" can be found in your administration.

REST API

Description:

List of your orders

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/orders?limit=10&offset=0&sort=-created

JSON request:

GET https://client.api.fulfillment.cz/v1/fulfillment/orders?limit=30&offset=0&sort=-created HTTP/1.1
Authorization: TOKEN
Accept: application/json

Request parameters description:
Key Type Mandatory Comment
id string No Order ID (to display a specific order)
ids array No Order IDs (to display specific orders)
remote_number string No Order number from your system
status string No Order status
created_from string No Order creation date FROM in format "Y-m-d"
created_to string No Order creation date TO in format "Y-m-d"
limit int No Number of requested records (default = 30, max = 100)
offset int No Determines the starting offset for results (default = 0)
sort string No Record sorting
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": "",
    "totalCount": 10,
    "data": [
        {
            "id": "da8bfbcb-5916-4416-b310-ce8ce6c0c63f",
            "number": "FF2996255084",
            "remote_number": "123456789",
            "currency_id": "CZK",
            "on_hold": true,
            "status": "problem_in_expedition",
            "status_note": "",
            "expedition": {
                "status": "problem",
                "problem": {
                    "source": "packing",
                    "description": "Produkt není k nalezení.",
                    "solution": NULL,
                    "postponed": true,
                    "photos": [],
                },
            },
            "recipient": {
                "email": "zakaznik@gmail.com",
                "phone": "777666555",
                "firstname": "Jan",
                "surname": "Novák",
                "street": "Korunní 21",
                "city": "Praha 2",
                "zipcode": "12800",
                "company": ""
            },
            "delivery": {
                "id": 25,
                "value": 999.0,
                "name": "DPD",
                "tracking_number": "xyz",
                "status": "inTransit"
            },
            "payment": {
                "cod": true,
                "variable_symbol": "1234567890",
                "price": 1001
            },
            "products": [
                {
                    "name": "Horké kameny",
                    "image": "https://cdn.fulfillment.cz/images/d/e/a/b/0/8/0/c/8/9/7c65758192e4f827ecxyz.png",
                    "code": "DS12345678",
                    "ext_code": null,
                    "quantity": 3
                }
            ],
            "packages": [
                {
                    "id": "edae9cfa-c07f-4e28-ba9b-d6ba3fc90749",
                    "items": [
                        {
                            "variant_id": 123,
                            "code": "DS12345678",
                            "ext_code": "XYZ",
                            "quantity": 3
                        }
                    ]
                }
            ],
            "invoice": "JVBERi0xLjMNCiXi48/TDQoNCjE...",
            "damaged": false,
            "note": "Poznámka",
            "tickets": [
                {
                    "barcode": "DR0705127648C",
                    "data": "^XA..."
                }
            ],
            "billing": {
                "fulfillment_price": 29.50,
                "shipping_price": null
            },
            "dispatch_date": "2025-12-21"
            "created": "2019-03-17 14:26:45"
        }
    ]
}
Response fields description:
Key Type Comment
status string Order status
  • created => Created
  • waiting_for_storage => Awaiting storage
  • in_expedition => In expedition
  • packed => packaged
  • canceled => Cancelled
  • problem_in_expedition => Problem in expedition
  • not_sent => Not sent
  • sent => Sent
  • delivered => Delivered
  • returned => Returned
delivery.status string|NULL Shipment status
  • inTransit => Handed over to carrier
  • delivered => Delivered
  • returned => Returned
expedition.status string Status in dispatch
  • waiting => The order is waiting for picking. If necessary, you can cancel the order in expedition.
  • picking => The order is in the process of picking.
  • waitingForPacking => The order is waiting for packing.
  • packing => The order is in the process of packing.
  • packed => The order has been completed and is waiting to be packaged.
  • problem => The order was marked as problematic and waiting for resolution.
  • problemSolved => The order has been canceled in the expedition and you can change its status if necessary.
  • finished => The order has been packaged and is waiting to be handed over to the courier.
  • picked => The order is waiting for packing.
  • packaging => The order is in the process of packaging.
  • packaged => Order was packaged.
status_note Order status note
expedition.problem.source Source of the problem
  • order => Order
  • picking => picking
  • packing => packing
  • packaging => Packaging
expedition.problem.description Problem description
expedition.problem.solution Problem resolution
expedition.problem.postponed The expedition of the order was only briefly postponed.
expedition.problem.photos Photos (URL array)
Description:

Inserting orders

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/orders

JSON request:

POST https://client.api.fulfillment.cz/v1/fulfillment/orders HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 Recommended header to prevent duplicate request submission. Use any string (char 36) unique to the specific request. Ideally UUID4 Wikipedia, PHP library

{
    "idempotency_key": "381e62f7-d11e-4291-97d4-be8a4851d4c2",
    "recipient": {
        "email": "zakaznik@gmail.com",
        "phone": "777666555",
        "firstname": "Jan",
        "surname": "Novák",
        "street": "Korunní 21",
        "city": "Praha 2",
        "zipcode": "12800",
        "company": ""
    },
    "delivery": {
        "id": 25,
        "value": 999.0,
        "place_id": null,
        "place_ext_id": null
    },
    "payment": {
        "cod": true,
        "variable_symbol": "1234567890",
        "price": 1001
    },
    "products": [
        {
            "code": "DS12345678",
            "ext_code": null,
            "bcx": BCX123456789,
            "quantity": 3
        }
    ],
    "sets": [
        {
            "code": "123456",
            "quantity": 3
        }
    ],
    "eshop": "https://www.uzasne-darky.cz",
    "currency_id": "EUR",
    "on_hold": true,
    "instant_reservation": true,
    "remote_number": "123456789",
    "invoice": "JVBERi0xLjMNCiXi48/TDQoNCjE...",
    "damaged": false,
    "note": "Poznámka",
    "tickets": [
        {
            "barcode": "DR0705127648C",
            "data": "^XA..."
        }
    ],
    "dispatch_date": "2025-12-21"
}

Request fields description:
Key Type Mandatory Comment
idempotency_key string No Unique order identifier from external system (duplicate entry protection)
recipient.email string Yes Customer email
recipient.phone string Yes Customer phone number
recipient.firstname string Yes Customer first name
recipient.surname string Yes Customer last name
recipient.street string Yes Customer street address
recipient.city string Yes Customer city
recipient.zipcode string Yes Customer postal code
recipient.company string No Customer company
delivery.id int Yes Delivery method ID
delivery.value float Yes Value of goods in the order, in the order currency
delivery.place_id1 int|NULL No Pickup point ID (from the fulfillment.cz system). See Delivery methods - Pickup points
delivery.place_ext_id1 string|NULL No Pick-up point ID (from an external service, e.g., zasilkovna.cz).
payment.cod bool Yes Is the order cash on delivery (COD)?
payment.variable_symbol string|NULL Condition Variable symbol (mandatory for COD orders)
payment.price float Yes Amount payable in the order currency. If the order is prepaid, send 0.
products[].code string|NULL Condition Product code from fulfillment.cz system. Optional if the product ext_code is provided
products[].ext_code string|NULL Condition Supplier product code. Optional if the product code is provided
products[].bcx string|NULL No BCX product code
products[].quantity int Yes Product quantity
sets[] array No Product sets
sets[].code string Yes Product set code
sets[].quantity int Yes Product quantity in product set
eshop string No Store URL (including http(s))
currency_id string No Order currency, default is set to CZK. The order currency must match the currency of the destination country.
on_hold bool No Does the order require manual sending to dispatch? Use for unpaid orders that must not be sent automatically
instant_reservation bool No Create stock reservations immediately upon order creation (default = false)
remote_number string Yes Order number from your system
invoice string|NULL No PDF invoice as a Base64-encoded string
damaged bool No Is this a shipment of damaged goods?
note string No Note
tickets[] array No Sending shipment via own carrier. Custom labels (in ZPL format) may only be used with prior agreement from fulfillment.cz technical support.
tickets[].barcode string Yes Tracking number must match the barcode on the label
tickets[].data string Yes Package ZPL code
dispatch_date string|NULL No Fill in if you want to delay order dispatch to a specific date (Y-m-d format)

1 To add a pickup point, use either an ID from our database or the service provider's database. The order will be accepted even if you send no ID (even if required by the shipping method), but it will not be forwarded to the supplier and the client will be prompted to add it in the admin panel.


JSON response:

HTTP/1.1 201
Content-type: application/json; 

{
    "id": "da8bfbcb-5916-4416-b310-ce8ce6c0c63f"
}
Response fields description:
Key Type Comment
id string Order UUID in fulfillment.cz system
Description:

Edit orders

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/orders/<orderId>

JSON request:

POST https://client.api.fulfillment.cz/v1/fulfillment/orders/<orderId> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 Recommended header to prevent duplicate request submission. Use any string (char 36) unique to the specific request. Ideally UUID4 Wikipedia, PHP library

{
    "recipient": {
        "email": "zakaznik@gmail.com",
        "phone": "777666555",
        "firstname": "Jan",
        "surname": "Novák",
        "street": "Korunní 21",
        "city": "Praha 2",
        "zipcode": "12800",
        "company": ""
    },
    "delivery": {
        "id": 25,
        "value": 999.0,
        "place_id": null,
        "place_ext_id": null
    },
    "payment": {
        "cod": true,
        "variable_symbol": "1234567890",
        "price": 1001
    },
    "products": [
        {
            "code": "DS12345678",
            "ext_code": null,
            "quantity": 3
        }
    ],
    "sets": [
        {
            "code": "123456",
            "quantity": 3
        }
    ],
    "eshop": "https://www.uzasne-darky.cz",
    "currency_id": "EUR",
    "on_hold": true,
    "instant_reservation": true,
    "remote_number": "123456789",
    "invoice": "JVBERi0xLjMNCiXi48/TDQoNCjE...",
    "damaged": false,
    "note": "Poznámka",
    "tickets": [
        {
            "barcode": "DR0705127648C",
            "data": "^XA..."
        }
    ],
    "dispatch_date": "2025-12-21"
}

Request fields description:
Key Type Mandatory Comment
recipient.email string Yes Customer email
recipient.phone string Yes Customer phone number
recipient.firstname string Yes Customer first name
recipient.surname string Yes Customer last name
recipient.street string Yes Customer street address
recipient.city string Yes Customer city
recipient.zipcode string Yes Customer postal code
recipient.company string No Customer company
delivery.id int Yes Delivery method ID
delivery.value float Yes Value of goods in the order, in the order currency
delivery.place_id1 int|NULL No Pickup point ID (from the fulfillment.cz system). See Delivery methods - Pickup points
delivery.place_ext_id1 string|NULL No Pick-up point ID (from an external service, e.g., zasilkovna.cz).
payment.cod bool Yes Is the order cash on delivery (COD)?
payment.variable_symbol string|NULL Condition Variable symbol (mandatory for COD orders)
payment.price float Yes Amount payable in the order currency. If the order is prepaid, send 0.
products[].code string|NULL Condition Product code from fulfillment.cz system. Optional if the product ext_code is provided
products[].ext_code string|NULL Condition Supplier product code. Optional if the product code is provided
products[].quantity int Yes Product quantity
sets[] array No Product sets
sets[].code string Yes Product set code
sets[].quantity int Yes Product quantity in product set
eshop string No Store URL (including http(s))
currency_id string No Order currency, default is set to CZK. The order currency must match the currency of the destination country.
on_hold bool No Does the order require manual sending to dispatch? Use for unpaid orders that must not be sent automatically
instant_reservation bool No Create stock reservations immediately upon order creation (default = false)
remote_number string Yes Order number from your system
invoice string|NULL No PDF invoice as a Base64-encoded string
damaged bool No Is this a shipment of damaged goods?
note string No Note
tickets[] array No Sending shipment via own carrier. Custom labels (in ZPL format) may only be used with prior agreement from fulfillment.cz technical support.
tickets[].barcode string Yes Tracking number must match the barcode on the label
tickets[].data string Yes Package ZPL code
dispatch_date string|NULL No Fill in if you want to delay order dispatch to a specific date (Y-m-d format)

1 To add a pickup point, use either an ID from our database or the service provider's database. The order will be accepted even if you send no ID (even if required by the shipping method), but it will not be forwarded to the supplier and the client will be prompted to add it in the admin panel.


JSON response:

HTTP/1.1 201
Content-type: application/json; 

{
    "id": "da8bfbcb-5916-4416-b310-ce8ce6c0c63f"
}
Response fields description:
Key Type Comment
id string Order UUID in fulfillment.cz system
Description:

Send order to dispatch

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/orders?id=da8bfbcb-5916-4416-b310-ce8ce6c0c63f

JSON request:

PATCH https://client.api.fulfillment.cz/v1/fulfillment/orders?id=da8bfbcb-5916-4416-b310-ce8ce6c0c63f HTTP/1.1
Authorization: TOKEN
Accept: application/json

JSON response:

HTTP/1.1 200

Description:

Order cancellation (status changed to "cancelled")

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/orders?id=da8bfbcb-5916-4416-b310-ce8ce6c0c63f

JSON request:

DELETE https://client.api.fulfillment.cz/v1/fulfillment/orders?id=da8bfbcb-5916-4416-b310-ce8ce6c0c63f HTTP/1.1
Authorization: TOKEN
Accept: application/json

JSON response:

HTTP/1.1 200


Description:

List of products

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/products?limit=100&offset=0

JSON request:

GET https://client.api.fulfillment.cz/v1/fulfillment/products?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Request parameters description:
Key Type Mandatory Comment
id string No Product ID (to display only a specific product)
active int No Variant activity (0/1)
code string No DS code of the variant
ext_code string No Supplier variant code
limit int No Number of requested records (default = 100, max = 100)
offset int No Determines the starting offset for results (default = 0)
sort string No Record sorting
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": "",
    "totalCount": 1,
    "data": [
        {
            "id": 1,
            "category_id": 1,
            "name": "Horké kameny",
            "description": "Popis",
            "description_html": "<strong>Popis</strong>",
            "variants": [
                {
                    "id": 1,
                    "sku_id": NULL,
                    "sku_code": NULL,
                    "size_id": A4,
                    "name": "červené",
                    "code": "DS12345678",
                    "ext_code": "xyz",
                    "ean": "...",
                    "clearance": false,
                    "price_purchase": null,
                    "price_wholesale": 43.21,
                    "price_retail": 81.81,
                    "price_retail_vat": 99,
                    "vat": 21,
                    "preview_image": "https://cdn.fulfillment.cz/images/3/3/c/3/3/9/2/3/c/2/ad49b23bd4e7ef694a131b.png",
                    "partner_warehouse_quantity": 3,
                    "partner_delivery_date": 0,
                    "inventory": {
                        "quantity": 3,
                        "reserved_quantity": 1,
                        "requested_quantity": 0,
                        "price_per_unit": 81.81,
                        "location": "A123"
                    }
                },
                {
                    "id": 2,
                    "sku_id": 5,
                    "sku_code": DS12345699,
                    "size_id": A4,
                    "name": "černé",
                    "code": "DS12345679",
                    "ext_code": "xzy",
                    "ean": "...",
                    "clearance": false,
                    "price_purchase": null,
                    "price_wholesale": 43.21,
                    "price_retail": 81.81,
                    "price_retail_vat": 99,
                    "vat": 21,
                    "preview_image": "https://cdn.fulfillment.cz/images/3/3/c/3/3/9/2/3/c/2/ad49b23bd4e7ef694a131c.png",
                    "partner_warehouse_quantity": null,
                    "partner_delivery_date": null,
                    "inventory": {
                        "quantity": 0,
                        "reserved_quantity": 0,
                        "requested_quantity": 2,
                        "price_per_unit": 81.81,
                        "location": "A123"
                    }
                }
            ]
        }
    ]
}
Response fields description:
Key Type Comment
id int Product ID
category_id int|NULL Category ID (if the product is assigned to a category).
name string Product name
description string Product description
description_html string HTML product description
variants.id int Variant ID
variants.sku_id int|NULL Parent variant ID
variants.sku_code string|NULL DS code of the parent variant
variants.size_id string|NULL Handling unit size
variants.name string Name of variant
variants.code string DS code of the variant
variants.ext_code string Your variant code
variants.ean string Variant EAN
variants.clearance bool Variant for clearance
variants.price_purchase float|NULL Purchase price of variant excluding VAT
variants.price_wholesale float|NULL Wholesale price of variant (excluding VAT)
variants.price_retail float|NULL Recommended retail price of the variant excluding VAT
variants.price_retail_vat int|NULL Recommended retail price of the variant including VAT
variants.vat int SALES TAX
variants.preview_image string Variant image
variants.partner_warehouse_quantity int|NULL Supplier stock quantity. NULL = in stock, exact number unknown
variants.partner_delivery_date int|NULL Supplier restocking lead time in days (if product not in stock). 0 = in stock, 60 = will not be restocked
variants.inventory.quantity int Total stock quantity (subtract reserved_quantity for available stock)
variants.inventory.reserved_quantity int Reserved quantity for pending orders
variants.inventory.requested_quantity int Requested variant quantity for pending orders
variants.inventory.price_per_unit float|NULL Average price per unit
variants.inventory.location string Warehouse location
Description:

Creating products

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/products

JSON request:

POST https://client.api.fulfillment.cz/v1/fulfillment/products HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 Recommended header to prevent duplicate request submission. Use any string (char 36) unique to the specific request. Ideally UUID4 Wikipedia, PHP library

{
    "category_id": 1,
    "name": "Horké kameny",
    "variant_name": "červené",
    "ext_code": "xyz",
    "ean": "...",
    "clearance": false,
    "description": "Popis",
    "description_html": "<strong>Popis</strong>",
    "price_purchase": null,
    "price_wholesale": 43.21,
    "price_retail_vat": 99,
    "vat": 21,
    "preview_image": "JVBERi0xLjMNCiXi48/TDQoNCjE...",
    "partner_warehouse_quantity": 3,
    "partner_delivery_date": 0,
}
Request fields description:
Key Type Mandatory Comment
category_id int|NULL Yes Category ID
name string Yes Product name
variant_name string Yes Variant name (if it is a product without variants, send an empty string)
ext_code string Yes Product/variant code from your system
ean string Yes Product/variant EAN
clearance bool Yes Product/variant for clearance
description string Yes Product description
description_html string Yes HTML product description
price_purchase float|NULL Yes Purchase price of variant excluding VAT
price_wholesale float|NULL Yes Wholesale price of variant (excluding VAT)
price_retail_vat int|NULL Yes Recommended retail price of the variant including VAT
vat int Yes SALES TAX (15/21)
preview_image string Yes Product/variant image as a base64 encoded string
partner_warehouse_quantity int|NULL No Supplier stock quantity. NULL = in stock, exact number unknown
partner_delivery_date int|NULL No Supplier restocking lead time in days (if product not in stock). 0 = in stock, 60 = will not be restocked
JSON response:

HTTP/1.1 201
Content-type: application/json; 

{
    "code": 201,
    "message": "",
    "data": {
        "id": 1,
        "variant_id": 1
        "variant_code": "DS12345678"
    }
}
Response fields description:
Key Type Comment
id int Product ID in fulfillment.cz system
variant_id int Variant ID in fulfillment.cz system
variant_code string Variant code in fulfillment.cz system
Description:

Product editing

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/products/<id>

JSON request:

POST https://client.api.fulfillment.cz/v1/fulfillment/products/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 Recommended header to prevent duplicate request submission. Use any string (char 36) unique to the specific request. Ideally UUID4 Wikipedia, PHP library

{
    "category_id": 1,
    "name": "Horké kameny",
    "description": "Popis",
    "description_html": "<strong>Popis</strong>",
}
Request fields description:
Key Type Mandatory Comment
category_id int|NULL Yes Category ID
name string Yes Product name
description string Yes Product description
description_html string Yes HTML product description
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": ""
}

Description:

List of variants for a specific product

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/products/<productId>/variants?limit=100&offset=0

JSON request:

GET https://client.api.fulfillment.cz/v1/fulfillment/products<productId>/variants?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Request parameters description:
Key Type Mandatory Comment
id string No Product ID (to display only a specific variant)
active int No Variant activity (0/1)
code string No DS code of the variant
ext_code string No Supplier variant code
limit int No Number of requested records (default = 100, max = 100)
offset int No Determines the starting offset for results (default = 0)
sort string No Record sorting
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": "",
    "totalCount": 2,
    "data": [
        {
            "id": 1,
            "sku_id": 5,
            "sku_code": DS12345699,
            "size_id": A4,
            "name": "červené",
            "code": "DS12345678",
            "ext_code": "xyz",
            "ean": "...",
            "clearance": false,
            "price_purchase": null,
            "price_wholesale": 43.21,
            "price_retail": 81.81,
            "price_retail_vat": 99,
            "vat": 21,
            "preview_image": "https://cdn.fulfillment.cz/images/3/3/c/3/3/9/2/3/c/2/ad49b23bd4e7ef694a131b.png",
            "partner_warehouse_quantity": 3,
            "partner_delivery_date": 0,
            "inventory": {
                "quantity": 3,
                "reserved_quantity": 1,
                "requested_quantity": 0,
                "price_per_unit": 81.81,
                "location": "A123"
            }
        },
        {
            "id": 2,
            "sku_id": NULL,
            "sku_code": NULL,
            "size_id": A4,
            "name": "černé",
            "code": "DS12345679",
            "ext_code": "xzy",
            "ean": "...",
            "clearance": false,
            "price_purchase": null,
            "price_wholesale": 43.21,
            "price_retail": 81.81,
            "price_retail_vat": 99,
            "vat": 21,
            "preview_image": "https://cdn.fulfillment.cz/images/3/3/c/3/3/9/2/3/c/2/ad49b23bd4e7ef694a131c.png",
            "partner_warehouse_quantity": null,
            "partner_delivery_date": null,
            "inventory": {
                "quantity": 0,
                "reserved_quantity": 0,
                "requested_quantity": 2,
                "price_per_unit": 81.81,
                "location": "A123"
            }
        }
    ]
}
Response fields description:
Key Type Comment
id int Variant ID
sku_id int|NULL Parent variant ID
sku_code string|NULL DS code of the parent variant
size_id string|NULL Handling unit size
name string Name of variant
code string DS code of the variant
ext_code string Your variant code
ean string Variant EAN
clearance bool Variant for clearance
price_purchase float|NULL Purchase price of variant excluding VAT
price_wholesale float|NULL Wholesale price of variant (excluding VAT)
price_retail float|NULL Recommended retail price of the variant excluding VAT
price_retail_vat int|NULL Recommended retail price of the variant including VAT
vat int SALES TAX
preview_image string Variant image
partner_warehouse_quantity int|NULL Supplier stock quantity. NULL = in stock, exact number unknown
partner_delivery_date int|NULL Supplier restocking lead time in days (if product not in stock). 0 = in stock, 60 = will not be restocked
inventory.quantity int Total stock quantity (subtract reserved_quantity for available stock)
inventory.reserved_quantity int Reserved quantity for pending orders
inventory.requested_quantity int Requested variant quantity for pending orders
inventory.price_per_unit float|NULL Average price per unit
inventory.location string Warehouse location
Description:

Creating variants for a specific product

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/products/<productId>/variants

JSON request:

POST https://client.api.fulfillment.cz/v1/fulfillment/products/<productId>/variants HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 Recommended header to prevent duplicate request submission. Use any string (char 36) unique to the specific request. Ideally UUID4 Wikipedia, PHP library

{
    "name": "černé",
    "ext_code": "yzx",
    "ean": "...",
    "clearance": true,
    "price_purchase": null,
    "price_wholesale": 43.21,
    "price_retail_vat": 99,
    "vat": 21,
    "preview_image": "JVBERi0xLjMNCiXi48/TDQoNCjE...",
    "partner_warehouse_quantity": 3,
    "partner_delivery_date": 0,
}
Request fields description:
Key Type Mandatory Comment
name string Yes Name of variant
ext_code string Yes Product/variant code from your system
ean string Yes Product/variant EAN
clearance bool Yes Product/variant for clearance
price_purchase float|NULL Yes Purchase price of variant excluding VAT
price_wholesale float|NULL Yes Wholesale price of variant (excluding VAT)
price_retail_vat int|NULL Yes Recommended retail price of the variant including VAT
vat int Yes VAT (15/21)
preview_image string Yes Product/variant image as a base64 encoded string
partner_warehouse_quantity int|NULL No Supplier stock quantity. NULL = in stock, exact number unknown
partner_delivery_date int|NULL No Supplier restocking lead time in days (if product not in stock). 0 = in stock, 60 = will not be restocked
JSON response:

HTTP/1.1 201
Content-type: application/json; 

{
    "code": 201,
    "message": "",
    "data": {
        "id": 1
    }
}
Response fields description:
Key Type Comment
id int Variant ID in fulfillment.cz system
Description:

Variant editing

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/products/<productId>/variants/<id> (alias: https://client.api.fulfillment.cz/v1/fulfillment/variants/<id>)

JSON request:

POST https://client.api.fulfillment.cz/v1/fulfillment/products/<productId>/variants/<id> (alias: https://client.api.fulfillment.cz/v1/fulfillment/variants/<id>) HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 Recommended header to prevent duplicate request submission. Use any string (char 36) unique to the specific request. Ideally UUID4 Wikipedia, PHP library

{
    "name": "černé",
    "ext_code": "yzx",
    "ean": "...",
    "clearance": true,
    "price_purchase": null,
    "price_wholesale": 43.21,
    "price_retail_vat": 99,
    "vat": 21,
    "partner_warehouse_quantity": 3,
    "partner_delivery_date": 0,
}
Request fields description:
Key Type Mandatory Comment
name string Yes Name of variant
ext_code string Yes Product/variant code from your system
ean string Yes Product/variant EAN
clearance bool Yes Product/variant for clearance
price_purchase float|NULL Yes Purchase price of variant excluding VAT
price_wholesale float|NULL Yes Wholesale price of variant (excluding VAT)
price_retail_vat int|NULL Yes Recommended retail price of the variant including VAT
vat int Yes SALES TAX (15/21)
preview_image string No To keep the current variant image, omit this variable
partner_warehouse_quantity int|NULL No Supplier stock quantity. NULL = in stock, exact number unknown
partner_delivery_date int|NULL No Supplier restocking lead time in days (if product not in stock). 0 = in stock, 60 = will not be restocked
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": ""
}
Description:

Match variant with B2B variant

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/products/<productId>/variants/<id>

JSON request:

PATCH https://client.api.fulfillment.cz/v1/fulfillment/products/<productId>/variants/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Command: PairSku 

{
    "sku_id": 1,
    "sku_code": "DS95688674"
}
Request fields description:
Key Type Mandatory Comment
sku_id int Condition B2B variant ID. Optional if sku_code is provided.
sku_code string Condition B2B variant code. Optional if the sku_id parameter is provided.
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": ""
}

Description:

List of product categories

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/product-categories?limit=100&offset=0

JSON request:

GET https://client.api.fulfillment.cz/v1/fulfillment/product-categories?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Request parameters description:
Key Type Mandatory Comment
id string No Category ID (to display only a specific category)
limit int No Number of requested records (default = 100, max = 1000)
offset int No Determines the starting offset for results (default = 0)
sort string No Record sorting
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": "",
    "totalCount": 10,
    "data": [
        {
            "id": 1,
            "parent": 0,
            "name": "Pro muže"
        }
    ]
}
Response fields description:
Key Type Comment
id int Category ID
parent int Parent category ID. The highest-level categories have parent = 0.
name string Name of category
Description:

Creating categories

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/product-categories

JSON request:

POST https://client.api.fulfillment.cz/v1/fulfillment/product-categories HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 Recommended header to prevent duplicate request submission. Use any string (char 36) unique to the specific request. Ideally UUID4 Wikipedia, PHP library

{
    "name": "Pro muže",
    "parent": 0
}
Request fields description:
Key Type Mandatory Comment
name string Yes Name of category
parent int Yes Parent category ID. The highest-level categories have parent = 0.
JSON response:

HTTP/1.1 201
Content-type: application/json; 

{
    "code": 201,
    "message": "",
    "data": {
        "id": 1
    }
}
Response fields description:
Key Type Comment
id int Category ID in fulfillment.cz system
Description:

Category editing

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/product-categories/<id>

JSON request:

POST https://client.api.fulfillment.cz/v1/fulfillment/product-categories/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 Recommended header to prevent duplicate request submission. Use any string (char 36) unique to the specific request. Ideally UUID4 Wikipedia, PHP library

{
    "name": "Pro muže",
    "parent": 0
}
Request fields description:
Key Type Mandatory Comment
name string Yes Name of category
parent int Yes Parent category ID. The highest-level categories have parent = 0.
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": ""
}
Description:

Delete category

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/product-categories/<id>

JSON request:

POST https://client.api.fulfillment.cz/v1/fulfillment/product-categories/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 Recommended header to prevent duplicate request submission. Use any string (char 36) unique to the specific request. Ideally UUID4 Wikipedia, PHP library


JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": ""
}

Description:

List of stock variants

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/warehouse-variants?limit=100&offset=0

JSON request:

GET https://client.api.fulfillment.cz/v1/fulfillment/warehouse-variants?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Request parameters description:
Key Type Mandatory Comment
variant_id string No Variant ID (to display only a specific variant)
variant_ids array No Variant IDs (array)
quantity_from int No Undamaged stock quantity ≥ quantity_from
damaged_quantity_from int No Damaged stock quantity ≥ damaged_quantity_from
total_quantity_from int No Total (damaged or undamaged) stock quantity ≥ total_quantity_from
limit int No Number of requested records (default = 100, max = 1000)
offset int No Determines the starting offset for results (default = 0)
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": "",
    "totalCount": 1,
    "data": [
        {
            "variant_id": 1887274,
            "code": "DS62202039",
            "ext_code": "123",
            "quantity": 3,
            "available_quantity": 2,
            "damaged_quantity": 0,
            "reserved_quantity": 1,
            "requested_quantity": 0,
            "price_per_unit": 99
        }
    ]
}
Response fields description:
Key Type Comment
variant_id int Variant ID from fulfillment.cz system
code string Variant code from fulfillment.cz system
code string Your variant code
quantity int Total undamaged stock quantity (subtract reserved_quantity for available stock)
available_quantity int Available quantity of undamaged stock in total, after subtracting reservations and requests (can be negative).
damaged_quantity int Total damaged stock quantity
reserved_quantity int Reserved quantity for pending orders
requested_quantity int Requested variant quantity for pending orders
price_per_unit float|NULL Average price per unit

Description:

List of receivings

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/warehouse-preloads?limit=100&offset=0

JSON request:

GET https://client.api.fulfillment.cz/v1/fulfillment/warehouse-preloads?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Request parameters description:
Key Type Mandatory Comment
id string No Receiving ID
ids array No Receiving batch ID
uuid string No Receiving UUID4
uuids array No Receiving batch UUID4
ext_id string No External receiving identifier
limit int No Number of requested records (default = 100, max = 1000)
offset int No Determines the starting offset for results (default = 0)
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": "",
    "totalCount": 1,
    "data": [
        {
            "id": 1,
            "uuid": "7b73a4a1-ef89-4574-9321-d4134414ced5",
            "ext_id": "38582ff4-b6ce-4a1e-acfb-5085b73fdbf1",
            "ext_code": "123456",
            "closed": true,
            "extra_cost": 0,
            "note": "poznámka",
            "receiving_note": "poznámka k naskladnění",
            "date_of_delivery": "2025-12-31",
            "items": [
                {
                    "variant_id": 1,
                    "code": "DS12345678",
                    "ext_code": "123",
                    "price_per_unit": 99.99,
                    "quantity": 3,
                    "received_quantity": 2,
                    "damaged_quantity": 1,
                    "photos": ["https://cdn.fulfillment.cz/images/9/3/4/f/a/a/e/a/1/0/b31ea2df5b933d6cf9b661.png"]
                }
            ],
            "stock_items": [
                {
                    "variant_id": 1,
                    "code": "DS12345678",
                    "ext_code": "123",
                    "quality": 1,
                    "expiration": "2030-12-31",
                    "batch_number": null,
                    "lot_id": null,
                    "received_quantity": 1,
                },
				{
                    "variant_id": 1,
                    "code": "DS12345678",
                    "ext_code": "123",
                    "quality": 1,
                    "expiration": "2028-12-31",
                    "batch_number": null,
                    "lot_id": null,
                    "received_quantity": 1,
                },
				{
                    "variant_id": 1,
                    "code": "DS12345678",
                    "ext_code": "123",
                    "quality": 0,
                    "expiration": "2028-12-31",
                    "batch_number": null,
                    "lot_id": null,
                    "received_quantity": 1,
                }
            ],
            "packages": [
                {
                    "size_id": "L1" // DEPRICATED
                    "barcode": "123456789"
                }
            ],
            "delivery_units": [
                {
                    "id": "d323b5e9-bab6-4d67-9550-0b93b63c8265",
                    "size_id": "L1",
                    "closed": false,
                }
            ],
            "notes": [
                {
                    "text": "Text poznamky"
                    "created": "2022-01-31 08:01:01"
                }
            ],
            "received_at": "2022-03-04"
        }
    ]
}
Response fields description:
Key Type Comment
id int Receiving ID
uuid string Receiving UUID4
ext_id string|NULL External receiving identifier (e.g., Goods Received Note number from ERP)
ext_code string|NULL External receiving number (e.g., Goods Received Note number from ERP)
closed bool Is the receiving finished?
extra_cost float Stocking costs excluding VAT
note string Note
receiving_note string Restocking note (deprecated - see notes[] for restocking notes)
date_of_delivery string Estimated delivery date
items[].variantId int Product ID from fulfillment.cz system
items[].code string Product code from fulfillment.cz system
items[].ext_code string Supplier product code
items[].price_per_unit float Price per piece without VAT
items[].quantity int Number of pieces
items[].received_quantity int|NULL Quantity actually stocked
items[].damaged_quantity int|NULL Damaged quantity
items[].photos array Photo documentation, typically in case of receiving damaged items
stock_items[].variantId int Product ID from fulfillment.cz system
stock_items[].code string Product code from fulfillment.cz system
stock_items[].ext_code string Supplier product code
stock_items[].quality int Product quality (0 = damaged, 1 = undamaged)
stock_items[].expiration string|NULL Product expiration date (Y-m-d). If the value is NULL, expiration is not set.
stock_items[].batch_number string|NULL Product batch number. If the value is NULL, the batch is not set.
stock_items[].lot_id string|NULL Product Lot ID. If the value is NULL, the Lot ID is not set.
stock_items[].received_quantity int Quantity actually stocked
packages[].size_id string|NULL Package size (DEPRICATED)
packages[].barcode string Tracking number (package)
delivery_units array List of stocked packages
delivery_units[].id string Package UUID4
delivery_units[].size_id string|NULL Package size
delivery_units[].closed bool Has the package receiving process been definitively closed?
notes[].text string Note text
notes[].created string Note creation date and time in format "Y-m-d H:i:s"
received_at string|NULL Latest receiving date (Y-m-d)
Description:

Creating receivings

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/warehouse-preloads

JSON request:

POST https://client.api.fulfillment.cz/v1/fulfillment/warehouse-preloads HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 Recommended header to prevent duplicate request submission. Use any string (char 36) unique to the specific request. Ideally UUID4 Wikipedia, PHP library

{
    "ext_id": "ba73abe4-a101-4c9c-9f05-592d0761bb83",
    "extra_cost": 0,
    "note": "poznámka",
    "date_of_delivery": "2025-12-31",
    "items": [
        {
            "code": "DS12345678",
            "ext_code": null,
            "price_per_unit": 99.99,
            "quantity": 3
        }
    ],
    "packages": [
        {
            "barcode": "123456789"
        }
    ]
}
Request fields description:
Key Type Mandatory Comment
ext_id string|NULL No External receiving identifier (e.g., Goods Received Note number from ERP)
extra_cost float Yes Stocking costs excluding VAT
note string No Note
date_of_delivery string Yes Estimated delivery date
items[].code string Condition Product code from fulfillment.cz system. Optional if the product ext_code is provided
items[].ext_code string Condition Supplier product code. Optional if the product code is provided
items[].price_per_unit float Yes Price per piece without VAT
items[].quantity int Yes Number of pieces
packages[].barcode string No Tracking numbers (packages)
JSON response:

HTTP/1.1 201
Content-type: application/json; 

{
    "code": 201,
    "message": "",
    "data": {
        "id": 1
    }
}
Response fields description:
Key Type Comment
id int Receiving ID in fulfillment.cz system
Description:

Edit receiving details

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/warehouse-preloads/<id>

JSON request:

POST https://client.api.fulfillment.cz/v1/fulfillment/warehouse-preloads/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 Recommended header to prevent duplicate request submission. Use any string (char 36) unique to the specific request. Ideally UUID4 Wikipedia, PHP library

{
    "ext_id": "ba73abe4-a101-4c9c-9f05-592d0761bb83",
    "extra_cost": 0,
    "note": "poznámka",
    "date_of_delivery": "2025-12-31",
    "items": [
        {
            "code": "DS12345678",
            "ext_code": null,
            "price_per_unit": 99.99,
            "quantity": 3
        }
    ],
    "packages": [
        {
            "barcode": "123456789"
        }
    ]
}
Request fields description:
Key Type Mandatory Comment
ext_id string|NULL No External receiving identifier (e.g., Goods Received Note number from ERP)
extra_cost float Yes Stocking costs excluding VAT
note string No Note
date_of_delivery string Yes Estimated delivery date
items[].code string Condition Product code from fulfillment.cz system. Optional if the product ext_code is provided
items[].ext_code string Condition Supplier product code. Optional if the product code is provided
items[].price_per_unit float Yes Price per piece without VAT
items[].quantity int Yes Number of pieces
packages[].barcode string No Tracking numbers (packages)
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": ""
}
Description:

Delete receiving

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/warehouse-preloads/<id>

JSON request:

POST https://client.api.fulfillment.cz/v1/fulfillment/warehouse-preloads/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 Recommended header to prevent duplicate request submission. Use any string (char 36) unique to the specific request. Ideally UUID4 Wikipedia, PHP library


JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": ""
}

Description:

List of requests

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/warehouse-requests?limit=100&offset=0

JSON request:

GET https://client.api.fulfillment.cz/v1/fulfillment/warehouse-requests?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Request parameters description:
Key Type Mandatory Comment
id string No Request ID
limit int No Number of requested records (default = 100, max = 1000)
offset int No Determines the starting offset for results (default = 0)
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": "",
    "totalCount": 1,
    "data": [
        {
            "id": 1,
            "variant_id": 1,
            "variant_code": "DS12471440",
            "variant_ext_code": "xyz",
            "quantity": 3,
            "date_of_delivery": "2025-12-31",
            "created": "2025-12-31 12:12:12",
        }
    ]
}
Response fields description:
Key Type Comment
id int Request ID
variant_id int Product ID from fulfillment.cz system
variant_code string Product code from fulfillment.cz system
variant_ext_code string Supplier product code
quantity int Number of pieces
date_of_delivery string|NULL Estimated delivery date
created string Request creation date and time
Description:

Edit estimated delivery date

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/warehouse-requests/<id>

JSON request:

POST https://client.api.fulfillment.cz/v1/fulfillment/warehouse-requests/<id> HTTP/1.1
Authorization: TOKEN
Accept: application/json
Idempotency-Key: string1

1 Recommended header to prevent duplicate request submission. Use any string (char 36) unique to the specific request. Ideally UUID4 Wikipedia, PHP library

{
    "date_of_delivery": "2025-12-31",
}
Request fields description:
date_of_delivery string Yes Estimated delivery date
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": ""
}

Description:

List of movements

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/warehouse-movements?limit=100&offset=0

JSON request:

GET https://client.api.fulfillment.cz/v1/fulfillment/warehouse-movements?limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Request parameters description:
Key Type Mandatory Comment
id int No Movement ID
idFrom int No Movement ID from (ID is an ascending integer...)
limit int No Number of requested records (default = 100, max = 1000)
offset int No Determines the starting offset for results (default = 0)
dateFrom string No Start date in format Y-m-d (e.g., 2020-01-31).
dateTo string No End date in format Y-m-d (e.g., 2020-01-31).

Záznamy jsou vždy řazeny od nejnovějšího po nejstarší.

JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": "",
    "totalCount": 1,
    "data": [
        {
            "id": 1,
            "variant_id": 1,
            "movement": "in",
            "reason": null,
            "order_id": null,
            "order_number": null,
            "b2b_order_id": null,
            "stock_taking_id": null,
            "fulfillment_order_id": null,
            "preload_id": 1751,
            "reload_id": null,
            "price_per_unit": 99.99,
            "extra_cost_per_unit": 0.0,
            "quantity": 3,
            "damaged_quantity": 0,
            "created": "2025-12-31 12:12:12",
        }
    ]
}
Response fields description:
Key Type Comment
id int Movement ID
variant_id int Variant ID from fulfillment.cz system
movement string Movement direction ("in" | "out")
reason obj|NULL Movement reason (if the value is NULL, no reason was specified)
reason.id int Movement reason ID
reason.name string Movement reason name
order_id int|NULL Dropshipping order ID
order_number string|NULL Dropshipping order number
b2b_order_id int|NULL B2B order ID
stock_taking_id string|NULL Inventory ID in UUID4 format
fulfillment_order_id string|NULL Fulfillment order ID in UUID4 format (IN = receiving return
preload_id int|NULL Receiving ID
reload_id int|NULL Transformation ID
price_per_unit float|NULL Unit price at which the item was received into stock
extra_cost_per_unit float|NULL Unit receiving cost per item
quantity int Number of pieces
damaged_quantity int Damaged quantity
created string Creation date and time in format "Y-m-d H:i:s"

Description:

List of active delivery methods

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/deliveries

JSON request:

GET https://client.api.fulfillment.cz/v1/fulfillment/deliveries HTTP/1.1
Authorization: TOKEN
Accept: application/json

JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "name": "Česká pošta",
            "price": 87.23, // Depricated
            "price_vat": 89, // Depricated
            "price_atyp": null, // Depricated
            "price_atyp_vat": null, // Depricated
            "price_oversized": null, // Depricated
            "price_oversized_vat": null, // Depricated
            "vat": 21, // Depricated
            "has_place": 1,
            "permitted_payment": ["1","2"] // Depricated
        }
    ]
}
Response fields description:
Key Type Comment
id int Delivery method ID
name string Name
has_place int Indicates whether a specific shipping method requires a pickup point to be sent (0 = NO; 1 = YES). See also "Delivery Methods - Pickup points

Description:

List of active pickup points for a specific delivery method

Full address:

https://client.api.fulfillment.cz/v1/fulfillment/delivery-places?deliveryId=10&limit=30&offset=0

JSON request:

GET https://client.api.fulfillment.cz/v1/fulfillment/delivery-places?deliveryId=10&limit=30&offset=0 HTTP/1.1
Authorization: TOKEN
Accept: application/json

Request parameters description:
Key Type Mandatory Comment
deliveryId int Yes Delivery method ID
limit int No Number of requested records (default = 30, no maximum)
offset int No Determines the starting offset for results (default = 0)
JSON response:

HTTP/1.1 200
Content-type: application/json; 

{
    "code": 200,
    "message": "",
    "data": [
        {
            "id": 1,
            "ext_id": "321",
            "place": "Zásilkovna s.r.o.",
            "street": "Vltavská 277/28",
            "city": "Praha",
            "zipcode": "150 00",
            "region_name": "Hlavní město Praha",
            "lat": "50.06980",
            "lon": "14.40607",
            "url": "http://www.zasilkovna.cz/point/praha-5-andel",
            "note": "",
            "direction": "Pobočka se nachází na v Praze na Smíchově 50 m od autobusového nádraží Na Knížecí.",
            "direction_car": "před pobočkou nelze parkovat. Je možné zaparkovat v ulicích Jindřich Plachty, nebo Staropramenná, jsou však dost plné. Jistější je zaparkovat v podzemních garážích pod Albertem - vjezd z ulice Bozděchova (200m), nebo na hlídaném parkovišti vedle polikliniky - vjezd z ulice Stroupežnického (200m), nebo na hlídaném parkovišti vedle aut. nádraží - vjezd z ulice Za ženskými domovy (200m)",
            "direction_public": "Pobočka se nachází 200m od východu z metra Anděl - Výstup na Knížecí",
            "opening_hour_short_html": "<strong>Po–Pá</strong> 10:00–19:00<br /><strong>So</strong> 10:00–15:00</span>",
            "opening_hour_table_html": "<table class="packetery-hours"><tr><th>Po</th><td>10:00–19:00</td></tr><tr><th>Út</th><td>10:00–19:00</td></tr><tr><th>St</th><td>10:00–19:00</td></tr><tr><th>Čt</th><td>10:00–19:00</td></tr><tr><th>Pá</th><td>10:00–19:00</td></tr><tr><th>So</th><td>10:00–15:00</td></tr><tr><th>Ne</th><td></td></tr></table>",
        }
    ]
}
Response fields description:
Key Type Comment
id int Pick-up point ID (in fulfillment.cz system)
ext_id string Pick-up point ID from the external provider’s system
place string Specific branch name
street string Street
city string City
zipcode string POSTCODE
region_name string Region
lat string GPS coordinates latitude
lon string GPS coordinates longitude
url string Branch detail URL on zasilkovna.cz
note string Note
direction string Branch location description
direction_car string Driving directions to branch
direction_public string Walking directions to branch
opening_hour_short_html string HTML table of opening hours, short version
opening_hour_table_html string HTML table of opening hours

WEBHOOKs

Description:

Order creation

Webhook request:

POST $endpoint1 HTTP/1.1
Authorization: $token2
Content-Type: application/json

1 URL endpoint, configured for your store for which the order is created

2 Your fulfillment.cz API authorization token

Webhook parameters:
Key Type Comment
event_id string Unique event identifier (UUID4 format)
event_type string Event type
data array Event data
created string Event creation date and time in format "Y-m-d H:i:s"
Example: 
{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderCreated",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
        "warehouse_id": "677bb033-e50e-4ddf-8a5c-97817314e650",
        "number": "FF701392",
        "remote_number": "1",
        "currency_id": "CZK",
        "on_hold": false,
        "recipient": {
            "email": "zakaznik@gmail.com",
            "phone": "777666555",
            "firstname": "Jan",
            "surname": "Novák",
            "street": "Korunní 21",
            "city": "Praha 2",
            "zipcode": "12800",
            "company": ""
        },
        "delivery": {
            "id": 25,
            "value": 999.0,
            "name": "DPD",
            "tracking_number": "xyz",
            "status": "inTransit"
        },
        "payment": {
            "cod": true,
            "variable_symbol": "1234567890",
            "price": 1001
        },
        "products": [
            {
                "name": "Horké kameny",
                "image": "https://cdn.fulfillment.cz/images/d/e/a/b/0/8/0/c/8/9/7c65758192e4f827ecxyz.png",
                "code": "DS12345678",
                "ext_code": null,
                "quantity": 3
            }
        ],
        "note": "",
        "tickets": [
            {
                "barcode": "DR0705127648C",
            }
        ],
        "created": "2020-10-28 06:45:23"
    },
    "created": "2020-10-28 06:45:23",
}
Event parameters:

For detailed parameter description see REST API - Orders

Expected response:

HTTP/1.1 200
Content-type: application/json; 

	

	

Description:

Order data change




	POST $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




1 URL endpoint, configured for your store for which the order is created


2 Your fulfillment.cz API authorization token


Webhook parameters:


	

		Key
		Type
		Comment
	

	

		event_id
		string
		Unique event identifier (UUID4 format)
	

	

		event_type
		string
		Event type
	

	

		data
		array
		Event data
	

	

		created
		string
		Event creation date and time in format "Y-m-d H:i:s"
	



Example:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderUpdated",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
        "number": "FF701392",
        "remote_number": "1",
        "currency_id": "CZK",
        "on_hold": false,
        "recipient": {
            "email": "zakaznik@gmail.com",
            "phone": "777666555",
            "firstname": "Jan",
            "surname": "Novák",
            "street": "Korunní 21",
            "city": "Praha 2",
            "zipcode": "12800",
            "company": ""
        },
        "delivery": {
            "id": 25,
            "value": 999.0,
            "name": "DPD",
            "tracking_number": "xyz",
            "status": "inTransit"
        },
        "payment": {
            "cod": true,
            "variable_symbol": "1234567890",
            "price": 1001
        },
        "products": [
            {
                "name": "Horké kameny",
                "image": "https://cdn.fulfillment.cz/images/d/e/a/b/0/8/0/c/8/9/7c65758192e4f827ecxyz.png",
                "code": "DS12345678",
                "ext_code": null,
                "quantity": 3
            }
        ],
        "note": "",
        "tickets": [
            {
                "barcode": "DR0705127648C",
            }
        ],
        "created": "2020-10-28 06:45:23"
    },
    "created": "2020-10-28 06:45:23",
}




Event parameters:

For detailed parameter description see REST API - Orders


Expected response:


	HTTP/1.1 200
	

	Content-type: application/json;



	

	

Description:

Order cancellation


Webhook request:



	POST $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




1 URL endpoint, configured for your store for which the order is created


2 Your fulfillment.cz API authorization token


Webhook parameters:


	

		Key
		Type
		Comment
	

	

		event_id
		string
		Unique event identifier (UUID4 format)
	

	

		event_type
		string
		Event type
	

	

		data
		array
		Event data
	

	

		created
		string
		Event creation date and time in format "Y-m-d H:i:s"
	



Example:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderCanceled",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}



Event parameters:

For detailed parameter description see REST API - Orders


Expected response:


	HTTP/1.1 200
	

	Content-type: application/json;



	

	

Description:

Shipment status change


Webhook request:



	POST $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




1 URL endpoint, configured for your store for which the order is created


2 Your fulfillment.cz API authorization token


Webhook parameters:


	

		Key
		Type
		Comment
	

	

		event_id
		string
		Unique event identifier (UUID4 format)
	

	

		event_type
		string
		Event type
	

	

		data
		array
		Event data
	

	

		created
		string
		Event creation date and time in format "Y-m-d H:i:s"
	



Example:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderDeliveryChanged",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
        "delivery": {
            "id": 25,
            "value": 999.0,
            "name": "DPD",
            "tracking_number": "xyz",
            "status": "inTransit"
        },
    },
    "created": "2020-10-28 06:45:23",
}



Event parameters:

For detailed parameter description see REST API - Orders


Expected response:


	HTTP/1.1 200
	

	Content-type: application/json;



	

	

Description:

Handover of order to warehouse for dispatch


Webhook request:



	POST $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




1 URL endpoint, configured for your store for which the order is created


2 Your fulfillment.cz API authorization token


Webhook parameters:


	

		Key
		Type
		Comment
	

	

		event_id
		string
		Unique event identifier (UUID4 format)
	

	

		event_type
		string
		Event type
	

	

		data
		array
		Event data
	

	

		created
		string
		Event creation date and time in format "Y-m-d H:i:s"
	



Example:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderPushedToExpedition",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}



Event parameters:

For detailed parameter description see REST API - Orders


Expected response:


	HTTP/1.1 200
	

	Content-type: application/json;



	

	

Description:

Order packaged and awaiting carrier pickup


Webhook request:



	POST $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




1 URL endpoint, configured for your store for which the order is created


2 Your fulfillment.cz API authorization token


Webhook parameters:


	

		Key
		Type
		Comment
	

	

		event_id
		string
		Unique event identifier (UUID4 format)
	

	

		event_type
		string
		Event type
	

	

		data
		array
		Event data
	

	

		created
		string
		Event creation date and time in format "Y-m-d H:i:s"
	



Example:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderPacked",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
        "delivery": {
            "id": 25,
            "value": 999.0,
            "name": "DPD",
            "tracking_number": "xyz",
            "status": "inTransit"
        },
    },
    "created": "2020-10-28 06:45:23",
}



Event parameters:

For detailed parameter description see REST API - Orders


Expected response:


	HTTP/1.1 200
	

	Content-type: application/json;



	

	

Description:

Order returned to warehouse


Webhook request:



	POST $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




1 URL endpoint, configured for your store for which the order is created


2 Your fulfillment.cz API authorization token


Webhook parameters:


	

		Key
		Type
		Comment
	

	

		event_id
		string
		Unique event identifier (UUID4 format)
	

	

		event_type
		string
		Event type
	

	

		data
		array
		Event data
	

	

		created
		string
		Event creation date and time in format "Y-m-d H:i:s"
	



Example:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderReturned",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}



Event parameters:

For detailed parameter description see REST API - Orders


Expected response:


	HTTP/1.1 200
	

	Content-type: application/json;



	

	

Description:

Order could not be shipped


Webhook request:



	POST $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




1 URL endpoint, configured for your store for which the order is created


2 Your fulfillment.cz API authorization token


Webhook parameters:


	

		Key
		Type
		Comment
	

	

		event_id
		string
		Unique event identifier (UUID4 format)
	

	

		event_type
		string
		Event type
	

	

		data
		array
		Event data
	

	

		created
		string
		Event creation date and time in format "Y-m-d H:i:s"
	



Example:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderNotSent",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
        "note": "Nadrozměr",
    },
    "created": "2020-10-28 06:45:23",
}



Event parameters:

For detailed parameter description see REST API - Orders


Expected response:


	HTTP/1.1 200
	

	Content-type: application/json;



	

	

Description:

Order shipped


Webhook request:



	POST $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




1 URL endpoint, configured for your store for which the order is created


2 Your fulfillment.cz API authorization token


Webhook parameters:


	

		Key
		Type
		Comment
	

	

		event_id
		string
		Unique event identifier (UUID4 format)
	

	

		event_type
		string
		Event type
	

	

		data
		array
		Event data
	

	

		created
		string
		Event creation date and time in format "Y-m-d H:i:s"
	



Example:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderSent",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}



Event parameters:

For detailed parameter description see REST API - Orders


Expected response:


	HTTP/1.1 200
	

	Content-type: application/json;



	

	

Description:

Order delivered


Webhook request:



	POST $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




1 URL endpoint, configured for your store for which the order is created


2 Your fulfillment.cz API authorization token


Webhook parameters:


	

		Key
		Type
		Comment
	

	

		event_id
		string
		Unique event identifier (UUID4 format)
	

	

		event_type
		string
		Event type
	

	

		data
		array
		Event data
	

	

		created
		string
		Event creation date and time in format "Y-m-d H:i:s"
	



Example:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderDelivered",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}



Event parameters:

For detailed parameter description see REST API - Orders


Expected response:


	HTTP/1.1 200
	

	Content-type: application/json;



	

	

Description:

Restore cancelled order


Webhook request:



	POST $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




1 URL endpoint, configured for your store for which the order is created


2 Your fulfillment.cz API authorization token


Webhook parameters:


	

		Key
		Type
		Comment
	

	

		event_id
		string
		Unique event identifier (UUID4 format)
	

	

		event_type
		string
		Event type
	

	

		data
		array
		Event data
	

	

		created
		string
		Event creation date and time in format "Y-m-d H:i:s"
	



Example:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderRestored",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}



Event parameters:

For detailed parameter description see REST API - Orders


Expected response:


	HTTP/1.1 200
	

	Content-type: application/json;



	

	

Description:

Order status changed to awaiting storage


Webhook request:



	POST $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




1 URL endpoint, configured for your store for which the order is created


2 Your fulfillment.cz API authorization token


Webhook parameters:


	

		Key
		Type
		Comment
	

	

		event_id
		string
		Unique event identifier (UUID4 format)
	

	

		event_type
		string
		Event type
	

	

		data
		array
		Event data
	

	

		created
		string
		Event creation date and time in format "Y-m-d H:i:s"
	



Example:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderStatusChangedToWaitingForStorage",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}



Event parameters:

For detailed parameter description see REST API - Orders


Expected response:


	HTTP/1.1 200
	

	Content-type: application/json;



	

	

Description:

Order status changed to created, usually when the order needs to be adjusted due to a shipping issue


Webhook request:



	POST $endpoint1 HTTP/1.1
	

	Authorization: $token2
	

	Content-Type: application/json




1 URL endpoint, configured for your store for which the order is created


2 Your fulfillment.cz API authorization token


Webhook parameters:


	

		Key
		Type
		Comment
	

	

		event_id
		string
		Unique event identifier (UUID4 format)
	

	

		event_type
		string
		Event type
	

	

		data
		array
		Event data
	

	

		created
		string
		Event creation date and time in format "Y-m-d H:i:s"
	



Example:

{
    "event_id": "c7f0963e-0f72-46bf-bdd1-fe6eec625960",
    "event_type": "OrderStatusChangedToCreated",
    "data": {
        "id": "7cad37e9-2624-480d-8c5f-68985522e7d0",
    },
    "created": "2020-10-28 06:45:23",
}



Event parameters:

For detailed parameter description see REST API - Orders


Expected response:


	HTTP/1.1 200
	

	Content-type: application/json;