BizKitHub
DocsAPI ReferenceOrder/api/v1/shop/order/set-ship-not-before
postOrderPublic API v1

/api/v1/shop/order/set-ship-not-before

Set, change or cancel the postponed shipping day of an order. While the day is in the future the order stays out of the fulfillment queue; when it arrives the order returns to the queue automatically and the organisation gets one notification. The order status is never changed.

orderpostApiV1ShopOrderSet-ship-not-before

Parameters

1 query · JSON body

Query parameters

· 1
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

Request body

application/json
orderIdstringRequired

Order hash.

Length: 32–32
ExamplesSO98YxzR4KJiOu66Jn6K3wRwa4FPI7S
shipNotBeforestring | nullRequired
One of 2:
Variant 1
string

Do not ship before this day (YYYY-MM-DD, Europe/Prague). null or "" cancels the postponement. Today or a past day means "ship now" and triggers no notification.

Example2026-12-15
Variant 2
null

Response schema

1 status code documented

200Success
success"true"Required
shipNotBeforestring | nullRequired
One of 2:
Variant 1
string
Example2026-12-15
Variant 2
null
isPendingbooleanRequired

True while the order waits for the day (outside the packing queue).

Response example

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

Request example

POST /api/v1/shop/order/set-ship-not-before

post
curl -X POST "https://api.bizkithub.com/api/v1/shop/order/set-ship-not-before?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "orderId": "sSO98YxzR4KJiOu66Jn6K3wRwa4FPI7S"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key