Set ExternalSync flag for Wros

curl --request POST \
  --url https://api.shipbob.com/Experimental/receiving/:set-external-sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    0
  ],
  "is_external_sync": true
}
'

{
  "box_labels_uri": "https://api.shipbob.com/1.0/receiving/1/labels",
  "box_packaging_type": "EverythingInOneBox",
  "expected_arrival_date": "2019-08-24T14:15:22Z",
  "external_sync_timestamp": "2019-08-24T14:15:22Z",
  "fulfillment_center": {
    "address1": "5900 W Ogden Ave",
    "address2": "Suite 100",
    "city": "Cicero",
    "country": "USA",
    "email": "[email protected]",
    "id": 0,
    "name": "Cicero (IL)",
    "phone_number": "555-555-5555",
    "state": "IL",
    "timezone": "Central Standard Time",
    "zip_code": "60804"
  },
  "id": 0,
  "insert_date": "2019-08-24T14:15:22Z",
  "inventory_quantities": [
    {
      "expected_quantity": 0,
      "inventory_id": 0,
      "received_quantity": 0,
      "sku": "string",
      "stowed_quantity": 0
    }
  ],
  "last_updated_date": "2019-08-24T14:15:22Z",
  "package_type": "Package",
  "purchase_order_number": "string",
  "status": "Awaiting"
}

POST

Experimental

receiving

:set-external-sync

Set ExternalSync flag for Wros

curl --request POST \
  --url https://api.shipbob.com/Experimental/receiving/:set-external-sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    0
  ],
  "is_external_sync": true
}
'

{
  "box_labels_uri": "https://api.shipbob.com/1.0/receiving/1/labels",
  "box_packaging_type": "EverythingInOneBox",
  "expected_arrival_date": "2019-08-24T14:15:22Z",
  "external_sync_timestamp": "2019-08-24T14:15:22Z",
  "fulfillment_center": {
    "address1": "5900 W Ogden Ave",
    "address2": "Suite 100",
    "city": "Cicero",
    "country": "USA",
    "email": "[email protected]",
    "id": 0,
    "name": "Cicero (IL)",
    "phone_number": "555-555-5555",
    "state": "IL",
    "timezone": "Central Standard Time",
    "zip_code": "60804"
  },
  "id": 0,
  "insert_date": "2019-08-24T14:15:22Z",
  "inventory_quantities": [
    {
      "expected_quantity": 0,
      "inventory_id": 0,
      "received_quantity": 0,
      "sku": "string",
      "stowed_quantity": 0
    }
  ],
  "last_updated_date": "2019-08-24T14:15:22Z",
  "package_type": "Package",
  "purchase_order_number": "string",
  "status": "Awaiting"
}

Authorizations

Authorization

string

header

required

Authentication using Personal Access Token (PAT) token

Body

application/json

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

ids

integer<int32>[] | null

is_external_sync

boolean

Response

Success

box_labels_uri

string | null

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

Example:

"https://api.shipbob.com/1.0/receiving/1/labels"

box_packaging_type

enum<string>

Available options:

EverythingInOneBox,

OneSkuPerBox,

MultipleSkuPerBox

expected_arrival_date

string<date-time>

Expected date that all packages will have arrived

external_sync_timestamp

string<date-time> | null

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

fulfillment_center

object

Information about a fulfillment center

Show child attributes

fulfillment_center.address1

string | null

Address line one of the fulfillment center

Example:

"5900 W Ogden Ave"

fulfillment_center.address2

string | null

Address line two of the fulfillment center

Example:

"Suite 100"

fulfillment_center.city

string | null

City the fulfillment center is located in

Example:

"Cicero"

fulfillment_center.country

string | null

Country the fulfillment center is located in

Example:

"USA"

fulfillment_center.email

string | null

Email contact for the fulfillment center

Example:

"[email protected]"

fulfillment_center.id

integer<int32>

Unique identifier of the fulfillment center

fulfillment_center.name

string | null

Name of the fulfillment center

Example:

"Cicero (IL)"

fulfillment_center.phone_number

string | null

Phone number contact for the fulfillment center

Example:

"555-555-5555"

fulfillment_center.state

string | null

State the fulfillment center is located in

Example:

"IL"

fulfillment_center.timezone

string | null

Timezone the fulfillment center is located in

Example:

"Central Standard Time"

fulfillment_center.zip_code

string | null

Postal code of the fulfillment center

Example:

"60804"

integer<int32>

Unique id of the warehouse receiving order

insert_date

string<date-time>

Insert date of the receiving order

inventory_quantities

object[] | null

Inventory items and quantities within the WRO

Show child attributes

inventory_quantities.expected_quantity

integer<int32>

Quantity of the inventory item submitted in the WRO

inventory_quantities.inventory_id

integer<int32>

ID of the inventory item

inventory_quantities.received_quantity

integer<int32>

Quantity of the inventory item received by the warehouse

inventory_quantities.sku

string | null

Sku of the inventory item

inventory_quantities.stowed_quantity

integer<int32>

Quantity of the inventory item stowed by the warehouse

last_updated_date

string<date-time>

Last date the receiving order was updated

package_type

enum<string>

Available options:

Package,

Pallet,

FloorLoadedContainer

purchase_order_number

string | null

Purchase order number for a receiving order

status

enum<string>

Available options:

Awaiting,

Processing,

Completed,

Cancelled,

Incomplete,

Arrived,

PartiallyArrived,

PartiallyArrivedAtHub,

ArrivedAtHub,

ProcessingAtHub,

InternalTransfer

Get All Inventory Levels Get Invoices

⌘I

API Reference

Authorizations

Body

Response