BizKitHub
DocsAPI ReferenceOrder/bff/order/update-ship-not-before
postOrderAdmin BFF

/bff/order/update-ship-not-before

Sets the day before which the order must not ship. While it is in the future the order stays out of the fulfillment queue; when it arrives the order returns to the queue and the organisation is notified.

OrderpostBffOrderUpdate-ship-not-before

Parameters

JSON body

Request body

application/json
orderHashstringRequired

Unique order hash identifier.

shipNotBeforestring | nullRequired
One of 2:
Variant 1
string

Do not ship before this day (YYYY-MM-DD, Prague). null or "" cancels the postponement.

Variant 2
null

Response schema

1 status code documented

200Success
successbooleanRequired
Default: true
shipNotBeforestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
isPendingbooleanRequired

Response example

application/json
{
  "success": true,
  "isPending": false
}

Request example

POST /bff/order/update-ship-not-before

post
curl -X POST "https://api.bizkithub.com/bff/order/update-ship-not-before" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "orderHash": "example_orderHash"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key