FulfillmentFulfillments

Get Many Fulfillments

Get multiple fulfillments with pagination and filtering

GET
/shipos/fulfillments
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 fulfillments by name or tracking code

Default""
warehouse_id?string

Filter by warehouse IDs (comma-separated for multiple)

Default""
shop_id?string

Filter by shop IDs (comma-separated for multiple)

Default""
order_id?string

Filter by order IDs (comma-separated for multiple)

Default""
fulfillment_order_id?string

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

Default""
package_id?string

Filter by package IDs (comma-separated for multiple)

Default""
status?string

Filter by fulfillment status (comma-separated for multiple)

Default""
shipment_status?string

Filter by shipment status (comma-separated for multiple)

Default""
type?string

Filter by fulfillment type (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

Default"created_at"

Value in

  • "created_at"
  • "updated_at"
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/fulfillments"
{  "data": [    {      "packed_by_user_name": "string",      "packed_by_user_id": "string",      "picked_by_user_name": "string",      "picked_by_user_id": "string",      "has_packshots": true,      "line_item_image_urls": [        "string"      ],      "unique_core_item_count": 0.1,      "total_core_item_quantity": 0.1,      "carton_name": "string",      "carton_id": "string",      "bulk_ship_id": "string",      "picking_session_id": "string",      "package_type": "FULFILLMENT_ORDER",      "shipping_label_label_url": "string",      "shipping_label_tracking_url": "string",      "fulfiller_team_name": "string",      "fulfiller_team_id": "string",      "merchant_team_name": "string",      "merchant_team_id": "string",      "package_id": "string",      "fulfillment_order_id": "string",      "warehouse_name": "string",      "warehouse_id": "string",      "order_id": "string",      "shop_name": "string",      "shop_id": "string",      "shipping_label_id": "string",      "formatted_service": "string",      "tracking_code": "string",      "type": "PICK_PACK",      "shipment_status": "LABEL_PRINTED",      "status": "PENDING",      "name": "string",      "remote_id": "string",      "synced_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "id": "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  }}