v1

latestSwagger 2.02026-07-13107214235.7 KB

Shipment

Create a shipment

post/v1/workgroups/{workgroup_id}/projects/{project_id}/shipments

Path parameters

workgroup_idstring required

project_idstring required

Request body

address_line1string

address_line2string

address_line3string

batch_labelstring

citystring

company_namestring

country_iso_codestring

delivery_datestring date

description_or_titlestring

emailstring

first_namestring

inner_carton_labelstring

last_namestring

middle_namestring

outer_carton_labelstring

pallet_lablelstring

poof_typestring

postal_codestring

request_typestring

requested_quantityinteger

shipping_carrierstring

shipping_instructionstring

shpping_methodstring

spec_idsstring

statestring

work_phone_numberstring

workgroup_namestring

Example request

{
  "address_line1": "sample address_line1",
  "address_line2": "sample address_line2",
  "address_line3": "sample address_line3",
  "batch_label": "sample batch_label",
  "city": "sample city",
  "company_name": "sample company_name",
  "country_iso_code": "sample country_iso_code",
  "description_or_title": "sample description_or_title",
  "email": "sample email",
  "first_name": "sample first_name",
  "inner_carton_label": "sample inner_carton_label",
  "last_name": "sample last_name",
  "middle_name": "sample middle_name",
  "outer_carton_label": "sample outer_carton_label",
  "pallet_lablel": "sample pallet_lablel",
  "poof_type": "sample poof_type",
  "postal_code": "sample postal_code",
  "request_type": "sample request_type",
  "shipment_custom_fields": [
    {
      "param_name": "sample param_name",
      "string_value": "sample string_value"
    }
  ],
  "shipment_request_custom_fields": [
    {
      "param_name": "sample param_name",
      "string_value": "sample string_value"
    }
  ],
  "shipping_carrier": "sample shipping_carrier",
  "shipping_instruction": "sample shipping_instruction",
  "shpping_method": "sample shpping_method",
  "spec_ids": "sample spec_ids",
  "state": "sample state",
  "work_phone_number": "sample work_phone_number",
  "workgroup_name": "sample workgroup_name"
}

Response

Successful created

status_codeinteger

status_reasonstring

Example response

{
  "status_reason": "sample status_reason"
}