The Overpacks resource allows a user to combine many Shipments into one object for faster clearance with BoxC and Customs. An overpack can be a carton, container, pallet, or bag. Regardless, it must contain an overpack label on the outside. The workflow for adding shipments to an overpack can be handled differently based on the use case. Empty overpacks are routinely purged from the system.

Example 1
  1. User creates an overpack by calling POST /overpacks, which returns a unique overpack ID.
  2. User creates several shipments with the overpack_id set to the aforementioned overpack ID. All shipments must have the same entry_point and service as the overpack.
  3. User has filled the overpack completely so they call PUT /overpacks/{id} to update the overpack with the final weight and dimensions.
  4. User prints a label for the overpack by calling GET /overpacks/{id}?type=pdf.
  5. User creates a manifest with one or more overpacks and retrieves their paperwork for the collection center using the Manifests resource.
Example 2
  1. User creates several shipments leaving the overpack_id empty.
  2. User is done creating shipments, so they create an overpack by calling POST /overpacks.
  3. User adds shipments to the overpack by scanning Labels. All shipments must have the same entry_point and service as the overpack.
  4. User adds the final weight and dimensions of the overpack in a PUT /overpacks/{id} request.
  5. User prints a label for the overpack by calling GET /overpacks/{id}?type=pdf.
  6. User creates a manifest with one or more overpacks and retrieves their paperwork for the collection center using the Manifests resource.

The overpack(s) must be dropped off at the BoxC collection center indicated by the entry_point. Deleting an overpack results in all shipments linked to the overpack to become unlinked.

Actions

GET /overpacks Retrieves a paginated list of overpacks
GET /overpacks/{id} Retrieves an overpack
POST /overpacks Creates an overpack
PUT /overpacks/{id} Updates an overpack
DELETE /overpacks/{id} Deletes an overpack

Properties

created

{"created": "2015-05-05 15:43:03"}

String - The date and time the overpack was created. Set by the system.
entry_point

{"entry_point": "SZXI01"}

String - The drop off location for this overpack. By default your application's entry point settings are inherited by the overpack. See Entry Points for a list of codes.

height

{"height": 50}

Integer - The height of the overpack in cm.
id

{"id": 12019}

Integer - The ID of the overpack. Set by the system.
length

{"length": 91}

Integer - The length of the overpack in cm.
locked

{"locked": false}

Boolean - Whether or not the overpack is locked. Overpacks are locked by the system when they are part of a manifest. Set by the sytem.
manifest_id

{"manifest_id": 1010023}

Integer - The ID of the manifest this overpack is linked to. Set by the system.
service

{"service": "BoxC Plus"}

String - The shipping service type. All shipments inside this overpack must have the same service. The available options are:
  • BoxC (default)
  • BoxC Plus
  • BoxC Priority
shipments

{
    "shipments": [
        {
            "id": 1212,
            "label_id": 781028,
            "tracking_number": "9274899999999900001785"
        },
        {
            "id": 1213,
            "label_id": 781029,
            "tracking_number": "9274899999999900001793"
        },
        {
            "id": 1214,
            "label_id": null,
            "tracking_number": null
        }
    ]
}

Array - A list of shipments and their tracking number and label ID (if any) inside this overpack. Shipments are added to overpacks when creating or updating Shipments, or by scanning Labels. Only present when getting a single overpack. Set by the system.

total_shipments

{"total_shipments": 432}

Integer - The total number of shipments in the overpack. Set by the system. Only present when getting a list of overpacks.
weight

{"weight": 87.5}

Decimal - The weight of the overpack in KG.
width

{"width": 30}

Integer - The width of the overpack in cm.
GET
/overpacks/{id}
Retrieves an overpack
type The data stream type if you don't want the overpack details. Only pdf is permitted
request
GET /overpacks/11232
response

HTTP/1.1 200 OK

{
    "overpack": {
        "created": "2015-08-21 08:13:55",
        "entry_point": "SZXI01",
        "height": 36,
        "id": 1123290,
        "length": 89,
        "locked": false,
        "manifest_id": null,
        "service": "BoxC Plus",
        "shipments": [
            {
                "id": 1212,
                "label_id": 781028,
                "tracking_number": "9274899999999900001785"
            },
            {
                "id": 1213,
                "label_id": 781029,
                "tracking_number": "9274899999999900001793"
            },
            {
                "id": 1214,
                "label_id": null,
                "tracking_number": null
            }
        ],
        "weight": 48.5,
        "width": 40
    }
}
request
GET /overpacks/11232
type=pdf
response

HTTP/1.1 200 OK

[blob]
POST
/overpacks
Creates an overpack
request
POST /overpacks
{
    "overpack": {
        "entry_point": "SZXI01",
        "height": 35,
        "length": 50,
        "service": "BoxC",
        "weight": 30.5,
        "width": 40
    }
}
response

HTTP/1.1 201 Created

{
    "overpack": {
        "created": "2015-08-21 10:33:12",
        "entry_point": "SZXI01",
        "height": 35,
        "id": 1123304,
        "length": 50,
        "locked": false,
        "manifest_id": null,
        "service": "BoxC",
        "shipments": [],
        "weight": 30.5,
        "width": 40
    }
}
PUT
/overpacks/{id}
Updates an overpack
request
PUT /overpacks/1123304
{
    "overpack": {
        "entry_point": "SZXI01",
        "service": "BoxC Plus",
        "height": 36,
        "length": 52,
        "weight": 32,
        "width": 41
    }
}
response

HTTP/1.1 200 OK

{
    "overpack": {
        "created": "2015-08-21 10:45:00",
        "entry_point": "SZXI01",
        "height": 36,
        "id": 1123304,
        "length": 52,
        "locked": false,
        "manifest_id": null,
        "service": "BoxC Plus",
        "shipments": [
            {
                "id": 1212,
                "label_id": 781027,
                "tracking_number": "9274899999999900001785"
            },
            {
                "id": 1213,
                "label_id": 781029,
                "tracking_number": "9274899999999900001793"
            },
            {
                "id": 1214,
                "label_id": null,
                "tracking_number": null
            }
        ],
        "weight": 32,
        "width": 41
    }
}
DELETE
/overpacks/{id}
Deletes an overpack
request
DELETE /overpacks/11233
response

HTTP/1.1 200 OK