OrdersFulfillment Orders

Acquire Lock

Acquire a lock on a fulfillment order

Acquires an exclusive lock on a fulfillment order to prevent concurrent fulfillment. The lock will automatically expire after the specified timeout (default 30 minutes).

If you already own the lock, calling this endpoint will extend the lock duration.

POST
/shipos/fulfillment-orders/{fulfillment_order_id}/lock
x-access-token<token>

In: header

Path Parameters

fulfillment_order_id*string

UUID of the fulfillment order to lock

Request Body

application/json

Request type for acquiring a fulfillment order lock

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/shipos/fulfillment-orders/string/lock" \  -H "Content-Type: application/json" \  -d '{    "lock_owner": "string"  }'
{  "success": true,  "lock_owner": "string",  "expires_at": "2019-08-24T14:15:22Z",  "extended": true,  "message": "string"}