FulfillmentPackages

Get Many Packages

Get multiple packages with pagination and filtering

GET
/shipos/packages
x-access-token<token>

In: header

Query Parameters

page?number

Page number for pagination (starting from 0)

Formatdouble
Default0
limit?number

Number of items per page

Formatdouble
Default20
search?string

Search term to filter packages by name

Default""
warehouse_id?string

Filter by warehouse IDs (comma-separated for multiple)

Default""
fulfillment_order_id?string

Filter by fulfillment order IDs (comma-separated for multiple)

Default""
status?string

Filter by package status (comma-separated for multiple)

Default""
carrier_integration_id?string

Filter by carrier integration IDs (comma-separated for multiple)

Default""
merchant_team_id?string

Filter by merchant team IDs (comma-separated for multiple)

Default""
order_by?string

Field to order results by (created_at, updated_at, name)

Default"created_at"

Value in

  • "created_at"
  • "updated_at"
  • "name"
order?string

Order direction

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/shipos/packages"
{  "data": [    {      "id": "string",      "idempotency_key": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "name": "string",      "manifested_at": "2019-08-24T14:15:22Z",      "shipped_at": "2019-08-24T14:15:22Z",      "status": "PENDING",      "packing_slip_url": "string",      "measurement_unit": "MM",      "type": "FULFILLMENT_ORDER",      "length": 0.1,      "width": 0.1,      "height": 0.1,      "weight_unit": "G",      "weight": 0.1,      "total_customs_value": 0,      "config": {        "require_pack_shot": true,        "show_unfulfilled_items_on_packing_list": true,        "show_prices_on_packing_slip": true,        "incoterm": "FAS",        "incoterm_location": "string",        "eel_pfc": "string",        "delivery_confirmation": "NO_SIGNATURE",        "saturday_delivery": true,        "insurance_policy": {          "mode": "none"        },        "customs_signer": "string",        "customs_signer_title": "string",        "customs_certify": true,        "non_delivery_option": "ABANDON",        "restriction_type": "NONE",        "restriction_comments": "string",        "contents_type": "OTHER",        "contents_explanation": "string",        "commercial_invoice_transaction_reason": "SALE",        "declaration": "string",        "commercial_invoice_payment_terms": "string",        "commercial_invoice_transport_mode": "string",        "commercial_invoice_port_of_entry": "string",        "commercial_invoice_country_of_transshipment": "string",        "commercial_invoice_package_marks": "string",        "commercial_invoice_freight_amount": 0,        "commercial_invoice_discount_amount": 0,        "commercial_invoice_other_charge_amount": 0,        "commercial_invoice_other_charge_description": "string",        "commercial_invoice_importer_tax_id": "string",        "commercial_invoice_importer_vat": "string",        "commercial_invoice_importer_eori": "string",        "commercial_invoice_importer_ioss": "string",        "commercial_invoice_vat_statement": "string",        "commercial_invoice_export_license_number": "string",        "destination_control_statement_required": true      },      "rate_error_data": {        "detailed_errors": [          {            "carrier_type": "GENERIC",            "message": "string"          }        ],        "available_rates": [          {            "currency": "string",            "amount": 0.1,            "service_name": "string",            "carrier_name": "string",            "service_id": "string",            "carrier_id": "string",            "carrier_integration_type": "GENERIC",            "carrier_integration_id": "string",            "estimated_days": 0,            "delivery_date_guaranteed": true,            "delivery_date": "string",            "provider_rate_id": "string"          }        ],        "message": "string"      },      "error_message": "string",      "carrier_id": "string",      "service_id": "string",      "provider_rate_id": "string",      "picking_session_id": "string",      "fulfillment_order_id": "string",      "work_order_id": "string",      "return_id": "string",      "carton_id": "string",      "shipping_label_id": "string",      "scan_form_id": "string",      "carrier_integration_id": "string",      "carrier_integration_name": "string",      "carrier_integration_type": "GENERIC",      "carton_name": "string",      "fulfiller_team_id": "string",      "fulfiller_team_name": "string",      "bulk_ship_id": "string",      "bulk_ship_template_package_id": "string",      "warehouse_id": "string",      "warehouse_name": "string",      "merchant_team_id": "string",      "merchant_team_name": "string",      "from_address_name": "string",      "from_address_company": "string",      "from_address_address1": "string",      "from_address_address2": "string",      "from_address_city": "string",      "from_address_state": "string",      "from_address_country": "string",      "from_address_zip": "string",      "from_address_phone": "string",      "from_address_email": "string",      "to_address_name": "string",      "to_address_company": "string",      "to_address_address1": "string",      "to_address_address2": "string",      "to_address_city": "string",      "to_address_state": "string",      "to_address_country": "string",      "to_address_zip": "string",      "to_address_phone": "string",      "to_address_email": "string",      "rate_shop_id": "string",      "rate_shop_name": "string",      "deliver_by": "2019-08-24T14:15:22Z",      "line_item_hash": "string",      "total_item_quantity": 0.1,      "unique_line_item_count": 0.1,      "formatted_service": "string",      "shipping_label_tracking_code": "string",      "shipping_label_tracking_url": "string",      "shipping_label_formatted_service": "string",      "shipping_label_url": "string",      "shipment_status": "LABEL_PRINTED",      "supported_actions": [        {          "action": "VIEW_PACKAGE"        }      ],      "package_preset_id": "string",      "package_preset_name": "string"    }  ],  "meta": {    "page": 0.1,    "page_size": 0.1,    "has_next_page": true,    "has_previous_page": true,    "start_index": 0.1,    "end_index": 0.1  }}