Inbound

The Inbound resource is part of the fulfillment component and allows customers to restock their products at warehouses operated by BoxC. An inbound shipment's products can't be modified after creation, but the warehouse, carrier, tracking number, and notes can be modified.

Inbound Status

The following table lists all possible states of an inbound shipment indicated by its status property. Only the system or warehouse can modify a shipment's status.

Status Description
Pending The inbound shipment was created and may be en route to the warehouse. Default state.
Received The inbound shipment arrived at the warehouse. It can no longer be updated or deleted.
Processed The inbound shipment was processed and inventoried by the warehouse.

Actions

GET /inbound Retrieves a paginated list of inbound shipments
GET /inbound/{id} Retrieves an inbound shipment
POST /inbound Creates an inbound shipment
PUT /inbound/{id} Updates an inbound shipment
DELETE /inbound/{id} Deletes an inbound shipment

Properties

carrier

{"carrier": "DHL"}

String - The carrier for the inbound shipment. Not required. Default: null. Max length: 32.
created

{"created": "2016-03-08 14:00:00"}

String - The date and time the inbound shipment was created. Set by the system.
id

{"id": 10000}

Integer - The unique ID of the inbound shipment. Set by the system.
notes

{"notes": "Manufacturer: XYZ; Delivery: 9/2/17"}

String - User defined notes for reference. Not required. Default: null. Max length: 64.
products 

{
    "products": [
        {
            "cost": 2.25,
            "id": 20111,
            "is_packaging": false,
            "name": "XL T-Shirt",
            "processed": 300,
            "quantity": 299,
            "codes": [
                {
                    "code": "Insufficient units arrived",
                    "quantity": 1
                }
            ]
        }
    ]
}

Array - An array of product objects that are part of the inbound shipment. Only present when creating or retrieving a shipment. Required. This property is immutable.

cost: Decimal - The cost per unit from the manufacturer for this product at the time of inbounding in USD. Optional.
id: Integer - The product ID.
is_packaging: Boolean - Indicates this product is packaging material. Set by the system.
name: String - The product name. Set by the system.
processed: Integer - The number of units processed by the warehouse. Set by the system.
quantity: Integer - The number of units being sent to the warehouse.
codes: Array - A list of codes describing problems with the units after processing. Set by the system.
received

{"received": "2016-03-15 08:00:00"}

String - The date and time the inbound shipment was received at the warehouse. Set by the system. Default: null.
status

{"status": "Pending"}

String - The status of the inbound shipment. Set by the system.
tracking_number

{"tracking_number": "9260193742120392200942"}

String - The tracking number for the inbound shipment. Not required. Default: null. Max length: 40.
warehouse 

{
    "warehouse": {
        "address": "Unit 5b, 102 Jinfanghua Ecommerce District\nShenzhen\nGD 518000\nChina",
        "id": "WH0SZ001",
        "language": "Chinese",
        "language_code": "zh",
        "name": "BoxC Shenzhen 1"
    }
}

Object - Information about the warehouse the inbound shipment is being sent to. Only the id is required when creating a shipment. View the Warehouses resource for a list.

address: String - The warehouse address with newlines (\n). Set by the system.
id: String - The unique warehouse ID. Required.
language: String - The local language for the warehouse.
language_code: String - The local language code for the warehouse in ISO 639-1 format.
name: String - The warehouse name. Set by the system.
GET
/inbound/{id}
Retrieves an inbound shipment
type The data stream type if you don't want the shipments details but need the product labels. Only PDF is accepted.
request
GET /inbound/100000
response

HTTP/1.1 200 OK

{
    "inbound": {
        "carrier": "DHL",
        "created": "2016-04-20 12:04:20",
        "id": 100000,
        "notes": null,
        "products": [
            {
                "cost": 2.25,
                "id": 20111,
                "is_packaging": false,
                "name": "XL T-Shirt",
                "processed": 0,
                "quantity": 300,
                "codes": null
            },
            {
                "cost": 2.25,
                "id": 20112,
                "is_packaging": false,
                "name": "SM T-Shirt",
                "processed": 0,
                "quantity": 200,
                "codes": null
            }
        ],
        "received": null,
        "status": "Pending",
        "tracking_number": "9260193742120392200942",
        "warehouse": {
            "address": "Unit 5b, 102 Jinfanghua Ecommerce District\nShenzhen\nGD 518000\nChina",
            "id": "WSZCN001",
            "language": "Chinese",
            "language_code": "zh",
            "name": "BoxC Shenzhen 1"
        }
    }
}
request
GET /inbound/100000 
type=pdf
response

HTTP/1.1 200 OK

[blob]
POST
/inbound
Creates an inbound shipment
request

POST /inbound

{
    "inbound": {
        "carrier": null,
        "notes": "Manufacturer: XYZ",
        "products": [
            {
                "cost": 2.25,
                "id": 20111,
                "quantity": 300
            },
            {
                "cost": 2.25,
                "id": 20112,
                "quantity": 200
            }
        ],
        "tracking_number": null,
        "warehouse": {
            "id": "WH0SZ001"
        }
    }
}
response

HTTP/1.1 201 Created

{
    "inbound": {
        "carrier": null,
        "created": "2016-04-20 12:04:20",
        "id": 100000,
        "notes": "Manufacturer: XYZ",
        "products": [
            {
                "cost": 2.25,
                "id": 20111,
                "is_packaging": false,
                "name": "XL T-Shirt",
                "processed": 0,
                "quantity": 300,
                "codes": null
            },
            {
                "cost": 2.25,
                "id": 20112,
                "is_packaging": false,
                "name": "SM T-Shirt",
                "processed": 0,
                "quantity": 200,
                "codes": null
            }
        ],
        "received": null,
        "status": "Pending",
        "tracking_number": null,
        "warehouse": {
            "address": "Unit 5b, 102 Jinfanghua Ecommerce District\nShenzhen\nGD 518000\nChina",
            "id": "WH0SZ001",
            "language": "Chinese",
            "language_code": "zh",
            "name": "BoxC Shenzhen 1"
        }
    }
}
PUT
/inbound/100000
Updates an inbound shipment
request

PUT /inbound/100000

{
    "inbound": {
        "carrier": "DHL",
        "notes": "Manufacturer: XYZ",
        "tracking_number": "9260193742120392200942",
        "warehouse": {
            "id": "WH0SZ001"
        }
    }
}
response

HTTP/1.1 200 OK

{
    "inbound": {
        "carrier": "DHL",
        "created": "2016-04-20 12:04:20",
        "id": 100000,
        "notes": "Manufacturer: XYZ",
        "products": [
            {
                "cost": 2.25,
                "id": 20111,
                "is_packaging": false,
                "name": "XL T-Shirt",
                "processed": 0,
                "quantity": 300,
                "codes": null
            },
            {
                "cost": 2.25,
                "id": 20112,
                "is_packaging": false,
                "name": "SM T-Shirt",
                "processed": 0,
                "quantity": 200,
                "codes": null
            }
        ],
        "received": null,
        "status": "Pending",
        "tracking_number": "9260193742120392200942",
        "warehouse": {
            "address": "Unit 5b, 102 Jinfanghua Ecommerce District\nShenzhen\nGD 518000\nChina",
            "id": "WH0SZ001",
            "language": "Chinese",
            "language_code": "zh",
            "name": "BoxC Shenzhen 1"
        }
    }
}
DELETE
/inbound/{id}
Deletes an inbound shipment
request
DELETE /inbound/100000
response

HTTP/1.1 200 OK