Create a shipping box

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

v1Operation ID v1_public_shipment_box_store

Creates a shipping box and returns it. The team's first box becomes the default; is_default: true makes a later one the default.

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

Needs the Manage Settings permission.

Business rules

• name, height, width, length and length_unit are required.
• Sizes are whole numbers in thousandths of the unit.
• length_unit is CM or IN.

Path parameters

• team_slugstringrequired

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

  • Example your-team

Request body

application/json, required.

• heightintegerrequired

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

• lengthintegerrequired

  The length, in thousandths of the unit (the size ×1000): 12500 is 12.5.

• length_unitstringrequired
  • One of: "CM", "IN"
• namestringrequired
• widthintegerrequired

  The width, in thousandths of the unit (the size ×1000): 12500 is 12.5.

• is_defaultboolean

  true makes it the team's default box. false does nothing.

• is_insuredboolean

Response

200Successful response.

• dataobjectrequired
  Child fields (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).

  When

  The API key is missing or wrong.

  Fix

  Send your personal API key as Authorization: Bearer YOUR_API_KEY.

• 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.

  When

  Your permission group lacks Manage Settings. This 403 has a short body, {"message": "Insufficient Permission"}, without success or error.

  Fix

  Ask the team owner to give your permission group Manage Settings.

• 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.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  A required field is missing, a size is not a whole number, or length_unit is not CM or IN. error.code is validation_failed, and error.fields names each field with its messages.

  Fix

  Fix the fields listed in error.fields and send the request again.

Related

• GETList shipping boxes/v1/api/store/{team_slug}/setting/shipment_box

Example request

curl

curl -X POST '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' \  -H 'Content-Type: application/json' \  -d '{    "height": 12000,    "length": 16000,    "length_unit": "IN",    "name": "Medium box",    "width": 12000  }'

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
}