> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer-stage.shipbob.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer-stage.shipbob.dev/_mcp/server. # Create Warehouse Receiving Order POST https://sandbox-api.shipbob.com/Experimental/receiving Content-Type: application/json Reference: https://developer-stage.shipbob.dev/experimental/api/receiving/create-warehouse-receiving-order ## Authentication - `Authorization` header (bearer token, required) — Authentication using Personal Access Token (PAT) token - `Authorization` header (bearer token, required) — OAuth2 authentication using JWT tokens ## Request ### Body (application/json) - `box_packaging_type` (enum, required) - Allowed values: `EverythingInOneBox`, `OneSkuPerBox`, `MultipleSkuPerBox` - `boxes` (list of object, required) — Box shipments to be added to this receiving order - `box_items` (list of object, required) — Items contained in this box. A receiving order may reference at most 10,000 unique inventory items (SKUs) across all of its boxes; exceeding this returns a 422 with the WRO_UNIQUE_SKU_LIMIT_EXCEEDED reason code. The limit applies to distinct inventory_ids across the whole order, not to a single box. - `quantity` (integer, required) — Quantity of the items in the box - `inventory_id` (integer, optional, nullable) — Unique inventory id of the items in the box (optional if sku is provided) - `lot_date` (datetime, optional, nullable) — Lot expiration date for the items in the box - `lot_number` (string, optional, nullable) — Lot number of the items in the box - `sku` (string, optional, nullable) — SKU identifier for the items in the box (optional if inventory_id is provided) - `tracking_number` (string, required) — Tracking number for the box shipment - `expected_arrival_date` (datetime, required) — Expected arrival date of all the box shipments in this receiving order - `fulfillment_center` (object, required) — Model containing information that assigns a receiving order to a fulfillment center. If the fulfillment center provided is in a receiving hub region, then the response will be the receiving hub location. - `id` (integer, required) — ID of the fulfillment center to assign this receiving order to - `package_type` (enum, required) - Allowed values: `Package`, `Pallet`, `FloorLoadedContainer` - `final_destination_fulfillment_center_id` (integer, optional, nullable) — Spoke site this receiving order is being routed to - `freight` (object, optional, nullable) — Optional container/freight metadata for this receiving order - `bol_number` (string, optional, nullable) — Bill of Lading number (the BOL number string, distinct from any uploaded BOL document) - `carrier` (string, optional, nullable) — Carrier name (e.g. Maersk, DHL, FedEx) - `container_number` (string, optional, nullable) — Shipping container number - `freight_forwarder` (string, optional, nullable) — Freight forwarder company name - `notes` (string, optional, nullable) — Free-text freight notes - `vessel_name` (string, optional, nullable) — Vessel (ship) name - `purchase_order_number` (string, optional, nullable) — Purchase order number for this receiving order ## Response ### 201 Created - `box_labels_uri` (string, optional, nullable) — URL to the packing slip to be included in each box shipment for this receiving order - `box_packaging_type` (enum, optional) - Allowed values: `EverythingInOneBox`, `OneSkuPerBox`, `MultipleSkuPerBox` - `expected_arrival_date` (datetime, optional) — Expected date that all packages will have arrived - `external_sync_timestamp` (datetime, optional, nullable) — The timestamp in UTC when a 3rd party integrator has set in our system - `freight` (object, optional, nullable) — Optional container/freight metadata for this receiving order (null when none was provided) - `bol_number` (string, optional, nullable) — Bill of Lading number (the BOL number string, distinct from any uploaded BOL document) - `carrier` (string, optional, nullable) — Carrier name (e.g. Maersk, DHL, FedEx) - `container_number` (string, optional, nullable) — Shipping container number - `freight_forwarder` (string, optional, nullable) — Freight forwarder company name - `notes` (string, optional, nullable) — Free-text freight notes - `vessel_name` (string, optional, nullable) — Vessel (ship) name - `fulfillment_center` (object, optional) — Information about a fulfillment center - `address1` (string, optional, nullable) — Address line one of the fulfillment center - `address2` (string, optional, nullable) — Address line two of the fulfillment center - `city` (string, optional, nullable) — City the fulfillment center is located in - `country` (string, optional, nullable) — Country the fulfillment center is located in - `email` (string, optional, nullable) — Email contact for the fulfillment center - `id` (integer, optional) — Unique identifier of the fulfillment center - `name` (string, optional, nullable) — Name of the fulfillment center - `phone_number` (string, optional, nullable) — Phone number contact for the fulfillment center - `state` (string, optional, nullable) — State the fulfillment center is located in - `timezone` (string, optional, nullable) — Timezone the fulfillment center is located in - `zip_code` (string, optional, nullable) — Postal code of the fulfillment center - `id` (integer, optional) — Unique id of the warehouse receiving order - `insert_date` (datetime, optional) — Insert date of the receiving order - `inventory_quantities` (list of object, optional, nullable) — Inventory items and quantities within the WRO - `expected_quantity` (integer, optional) — Quantity of the inventory item submitted in the WRO - `inventory_id` (integer, optional) — ID of the inventory item - `received_quantity` (integer, optional) — Quantity of the inventory item received by the warehouse - `sku` (string, optional, nullable) — Sku of the inventory item - `stowed_quantity` (integer, optional) — Quantity of the inventory item stowed by the warehouse - `last_updated_date` (datetime, optional) — Last date the receiving order was updated - `package_type` (enum, optional) - Allowed values: `Package`, `Pallet`, `FloorLoadedContainer` - `purchase_order_number` (string, optional, nullable) — Purchase order number for a receiving order - `status` (enum, optional) - Allowed values: `Awaiting`, `Processing`, `Completed`, `Cancelled`, `Incomplete`, `Arrived`, `PartiallyArrived`, `PartiallyArrivedAtHub`, `ArrivedAtHub`, `ProcessingAtHub`, `InternalTransfer` - `status_history` (list of object, optional, nullable) — The history of status changes for this receiving order - `id` (integer, optional) — Unique id of the status - `status` (string, optional, nullable) — Name of the status - `timestamp` (datetime, optional) — Timestamp when the status was recorded ## Examples **Request** ```json { "box_packaging_type": "EverythingInOneBox", "boxes": [ { "box_items": [ { "quantity": 1, "inventory_id": 0, "lot_date": "2019-08-24T14:15:22+00:00", "lot_number": "2222", "sku": "string" } ], "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC" } ], "expected_arrival_date": "2019-08-24T14:15:22+00:00", "fulfillment_center": { "id": 0 }, "package_type": "Package", "final_destination_fulfillment_center_id": 0, "freight": { "bol_number": "string", "carrier": "string", "container_number": "string", "freight_forwarder": "string", "notes": "string", "vessel_name": "string" }, "purchase_order_number": "string" } ``` **Response** ```json { "box_labels_uri": "https://api.shipbob.com/1.0/receiving/1/labels", "box_packaging_type": "EverythingInOneBox", "expected_arrival_date": "2019-08-24T14:15:22+00:00", "external_sync_timestamp": "2019-08-24T14:15:22+00:00", "freight": { "bol_number": "string", "carrier": "string", "container_number": "string", "freight_forwarder": "string", "notes": "string", "vessel_name": "string" }, "fulfillment_center": { "address1": "5900 W Ogden Ave", "address2": "Suite 100", "city": "Cicero", "country": "USA", "email": "example@example.com", "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:22+00:00", "inventory_quantities": [ { "expected_quantity": 0, "inventory_id": 0, "received_quantity": 0, "sku": "string", "stowed_quantity": 0 } ], "last_updated_date": "2019-08-24T14:15:22+00:00", "package_type": "Package", "purchase_order_number": "string", "status": "Awaiting", "status_history": [ { "id": 0, "status": "Processing", "timestamp": "2019-08-24T14:15:22+00:00" } ] } ``` **SDK Code** ```python default import requests url = "https://sandbox-api.shipbob.com/Experimental/receiving" payload = { "box_packaging_type": "EverythingInOneBox", "boxes": [ { "box_items": [ { "quantity": 1, "inventory_id": 0, "lot_date": "2019-08-24T14:15:22+00:00", "lot_number": "2222", "sku": "string" } ], "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC" } ], "expected_arrival_date": "2019-08-24T14:15:22+00:00", "fulfillment_center": { "id": 0 }, "package_type": "Package", "final_destination_fulfillment_center_id": 0, "freight": { "bol_number": "string", "carrier": "string", "container_number": "string", "freight_forwarder": "string", "notes": "string", "vessel_name": "string" }, "purchase_order_number": "string" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript default const url = 'https://sandbox-api.shipbob.com/Experimental/receiving'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"box_packaging_type":"EverythingInOneBox","boxes":[{"box_items":[{"quantity":1,"inventory_id":0,"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"2222","sku":"string"}],"tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC"}],"expected_arrival_date":"2019-08-24T14:15:22+00:00","fulfillment_center":{"id":0},"package_type":"Package","final_destination_fulfillment_center_id":0,"freight":{"bol_number":"string","carrier":"string","container_number":"string","freight_forwarder":"string","notes":"string","vessel_name":"string"},"purchase_order_number":"string"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go default package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://sandbox-api.shipbob.com/Experimental/receiving" payload := strings.NewReader("{\n \"box_packaging_type\": \"EverythingInOneBox\",\n \"boxes\": [\n {\n \"box_items\": [\n {\n \"quantity\": 1,\n \"inventory_id\": 0,\n \"lot_date\": \"2019-08-24T14:15:22+00:00\",\n \"lot_number\": \"2222\",\n \"sku\": \"string\"\n }\n ],\n \"tracking_number\": \"860C8CDC8F0B4FC7AB69AC86C20539EC\"\n }\n ],\n \"expected_arrival_date\": \"2019-08-24T14:15:22+00:00\",\n \"fulfillment_center\": {\n \"id\": 0\n },\n \"package_type\": \"Package\",\n \"final_destination_fulfillment_center_id\": 0,\n \"freight\": {\n \"bol_number\": \"string\",\n \"carrier\": \"string\",\n \"container_number\": \"string\",\n \"freight_forwarder\": \"string\",\n \"notes\": \"string\",\n \"vessel_name\": \"string\"\n },\n \"purchase_order_number\": \"string\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby default require 'uri' require 'net/http' url = URI("https://sandbox-api.shipbob.com/Experimental/receiving") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"box_packaging_type\": \"EverythingInOneBox\",\n \"boxes\": [\n {\n \"box_items\": [\n {\n \"quantity\": 1,\n \"inventory_id\": 0,\n \"lot_date\": \"2019-08-24T14:15:22+00:00\",\n \"lot_number\": \"2222\",\n \"sku\": \"string\"\n }\n ],\n \"tracking_number\": \"860C8CDC8F0B4FC7AB69AC86C20539EC\"\n }\n ],\n \"expected_arrival_date\": \"2019-08-24T14:15:22+00:00\",\n \"fulfillment_center\": {\n \"id\": 0\n },\n \"package_type\": \"Package\",\n \"final_destination_fulfillment_center_id\": 0,\n \"freight\": {\n \"bol_number\": \"string\",\n \"carrier\": \"string\",\n \"container_number\": \"string\",\n \"freight_forwarder\": \"string\",\n \"notes\": \"string\",\n \"vessel_name\": \"string\"\n },\n \"purchase_order_number\": \"string\"\n}" response = http.request(request) puts response.read_body ``` ```java default import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://sandbox-api.shipbob.com/Experimental/receiving") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"box_packaging_type\": \"EverythingInOneBox\",\n \"boxes\": [\n {\n \"box_items\": [\n {\n \"quantity\": 1,\n \"inventory_id\": 0,\n \"lot_date\": \"2019-08-24T14:15:22+00:00\",\n \"lot_number\": \"2222\",\n \"sku\": \"string\"\n }\n ],\n \"tracking_number\": \"860C8CDC8F0B4FC7AB69AC86C20539EC\"\n }\n ],\n \"expected_arrival_date\": \"2019-08-24T14:15:22+00:00\",\n \"fulfillment_center\": {\n \"id\": 0\n },\n \"package_type\": \"Package\",\n \"final_destination_fulfillment_center_id\": 0,\n \"freight\": {\n \"bol_number\": \"string\",\n \"carrier\": \"string\",\n \"container_number\": \"string\",\n \"freight_forwarder\": \"string\",\n \"notes\": \"string\",\n \"vessel_name\": \"string\"\n },\n \"purchase_order_number\": \"string\"\n}") .asString(); ``` ```php default request('POST', 'https://sandbox-api.shipbob.com/Experimental/receiving', [ 'body' => '{ "box_packaging_type": "EverythingInOneBox", "boxes": [ { "box_items": [ { "quantity": 1, "inventory_id": 0, "lot_date": "2019-08-24T14:15:22+00:00", "lot_number": "2222", "sku": "string" } ], "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC" } ], "expected_arrival_date": "2019-08-24T14:15:22+00:00", "fulfillment_center": { "id": 0 }, "package_type": "Package", "final_destination_fulfillment_center_id": 0, "freight": { "bol_number": "string", "carrier": "string", "container_number": "string", "freight_forwarder": "string", "notes": "string", "vessel_name": "string" }, "purchase_order_number": "string" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp default using RestSharp; var client = new RestClient("https://sandbox-api.shipbob.com/Experimental/receiving"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"box_packaging_type\": \"EverythingInOneBox\",\n \"boxes\": [\n {\n \"box_items\": [\n {\n \"quantity\": 1,\n \"inventory_id\": 0,\n \"lot_date\": \"2019-08-24T14:15:22+00:00\",\n \"lot_number\": \"2222\",\n \"sku\": \"string\"\n }\n ],\n \"tracking_number\": \"860C8CDC8F0B4FC7AB69AC86C20539EC\"\n }\n ],\n \"expected_arrival_date\": \"2019-08-24T14:15:22+00:00\",\n \"fulfillment_center\": {\n \"id\": 0\n },\n \"package_type\": \"Package\",\n \"final_destination_fulfillment_center_id\": 0,\n \"freight\": {\n \"bol_number\": \"string\",\n \"carrier\": \"string\",\n \"container_number\": \"string\",\n \"freight_forwarder\": \"string\",\n \"notes\": \"string\",\n \"vessel_name\": \"string\"\n },\n \"purchase_order_number\": \"string\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift default import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "box_packaging_type": "EverythingInOneBox", "boxes": [ [ "box_items": [ [ "quantity": 1, "inventory_id": 0, "lot_date": "2019-08-24T14:15:22+00:00", "lot_number": "2222", "sku": "string" ] ], "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC" ] ], "expected_arrival_date": "2019-08-24T14:15:22+00:00", "fulfillment_center": ["id": 0], "package_type": "Package", "final_destination_fulfillment_center_id": 0, "freight": [ "bol_number": "string", "carrier": "string", "container_number": "string", "freight_forwarder": "string", "notes": "string", "vessel_name": "string" ], "purchase_order_number": "string" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox-api.shipbob.com/Experimental/receiving")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```