List shipping boxes

GET/v1/api/store/{team_slug}/setting/shipment_box

v1Operation ID v1_public_shipment_box_index

Returns all the team's shipping boxes in one list.

Shipping boxes are saved box sizes. The web app offers them when you buy a shipping label with GoShippo, to fill in a parcel's size. Nothing links to a box by id, so changing or deleting a box doesn't change existing shipments or packages.

Permission

Any team member can call it. Reading needs no extra permission.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (8)

  • heightintegerrequired

    The height, in thousandths of the unit (the size ×1000): 12000 is 12.

  • idstringrequired
  • is_defaultbooleanrequired

    Whether it is the team's default box.

  • is_insuredbooleanrequired

    The box's Insured option.

  • lengthintegerrequired
  • length_unitstringrequired
    • One of: "CM", "IN"
  • namestringrequired
  • widthintegerrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Related

• POSTCreate a shipping box/v1/api/store/{team_slug}/setting/shipment_box

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/shipment_box' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "height": 12000,
      "id": "KkXRzp66r5WrEH",
      "is_default": true,
      "is_insured": false,
      "length": 16000,
      "length_unit": "IN",
      "name": "Medium box",
      "width": 12000
    }
  ],
  "status": 200,
  "success": true
}