Set ExternalSync flag for Wros

POST

/2026-07/receiving:setExternalSync

POST

/2026-07/receiving:setExternalSync

$ curl -X POST https://api.shipbob.com/2026-07/receiving:setExternalSync \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "ids": [
>     0
>   ],
>   "is_external_sync": true
> }'

1 {
2   "box_labels_uri": "https://api.shipbob.com/2026-07/receiving/1/labels",
3   "box_packaging_type": "EverythingInOneBox",
4   "expected_arrival_date": "2019-08-24T14:15:22+00:00",
5   "external_sync_timestamp": "2019-08-24T14:15:22+00:00",
6   "fulfillment_center": {
7     "address1": "5900 W Ogden Ave",
8     "address2": "Suite 100",
9     "city": "Cicero",
10     "country": "USA",
11     "email": "example@example.com",
12     "id": 0,
13     "name": "Cicero (IL)",
14     "phone_number": "555-555-5555",
15     "state": "IL",
16     "timezone": "Central Standard Time",
17     "zip_code": "60804"
18   },
19   "id": 0,
20   "insert_date": "2019-08-24T14:15:22+00:00",
21   "inventory_quantities": [
22     {
23       "expected_quantity": 0,
24       "inventory_id": 0,
25       "received_quantity": 0,
26       "sku": "string",
27       "stowed_quantity": 0
28     }
29   ],
30   "last_updated_date": "2019-08-24T14:15:22+00:00",
31   "package_type": "Package",
32   "purchase_order_number": "string",
33   "status": "Awaiting"
34 }

Sets the external sync flag for one or more warehouse receiving orders to enable or disable external synchronization.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Request

The list of wro ids and a flag to enable external sync

idslist of integers or nullOptional

is_external_syncbooleanOptional

Response

Success

box_labels_uristring or nullOptional

URL to the packing slip to be included in each box shipment for this receiving order

box_packaging_typeenumOptional

expected_arrival_datedatetimeOptional

Expected date that all packages will have arrived

external_sync_timestampdatetime or nullOptional

The timestamp in UTC when a 3rd party integrator has set in our system

fulfillment_centerobjectOptional

Information about a fulfillment center

idintegerOptional

Unique id of the warehouse receiving order

insert_datedatetimeOptional

Insert date of the receiving order

inventory_quantitieslist of objects or nullOptional

Inventory items and quantities within the WRO

last_updated_datedatetimeOptional

Last date the receiving order was updated

package_typeenumOptional

purchase_order_numberstring or nullOptional

Purchase order number for a receiving order

statusenumOptional

status_historylist of objects or nullOptional

The history of status changes for this receiving order

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error