OrdersFulfillment Orders

Get Many Fulfillment Orders

Get multiple fulfillment orders with pagination and filtering

GET
/shipos/fulfillment-orders
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 fulfillment orders

Default""
status?string

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

Default""
request_status?string

Filter by request status (comma-separated for multiple)

Default""
warehouse_id?string

Filter by warehouse IDs (comma-separated for multiple)

Default""
merchant_team_id?string

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

Default""
bulk_ship_id?string

Filter by batch IDs (comma-separated for multiple)

Default""
order_id?string

Filter by order IDs (comma-separated for multiple)

Default""
order_by?string

Field to order results by

Default"created_at"

Value in

  • "created_at"
  • "updated_at"
  • "fulfill_by"
  • "fulfilled_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/fulfillment-orders"
{  "data": [    {      "address_verification_response": {        "metadata": {          "is_active": true,          "is_cmra": true,          "is_vacant": true,          "record_type": "S",          "dpv_footnotes": "string",          "dpv_match_code": "Y",          "longitude": 0,          "latitude": 0        },        "errors": [          {            "message": "string",            "code": "string"          }        ],        "corrected_address": {          "zip4": "string",          "zip5": "string",          "state": "string",          "city": "string",          "street2": "string",          "street1": "string"        },        "residential": "RESIDENTIAL",        "verified": true      },      "address_verified_at": "2019-08-24T14:15:22Z",      "address_residential": "RESIDENTIAL",      "address_verified": true,      "rate_shop_name": "string",      "rate_shop_id": "string",      "priority": "LOW",      "formatted_service": "string",      "is_fragile": true,      "customer_email": "string",      "customer_name": "string",      "order_cancelled_at": "2019-08-24T14:15:22Z",      "order_remote_id": "string",      "order_number": "string",      "order_config": {        "require_pack_shot": true,        "show_unfulfilled_items_on_packing_list": true,        "show_prices_on_packing_slip": true,        "tote_qa_enabled": true,        "address_verification_enabled": 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      },      "config": {        "require_pack_shot": true,        "show_unfulfilled_items_on_packing_list": true,        "show_prices_on_packing_slip": true,        "tote_qa_enabled": 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      },      "shop_type": "SHOPIFY",      "shop_slug": "string",      "shop_name": "string",      "shop_id": "string",      "shipment_mapping_id": "string",      "carrier_integration_name": "string",      "carrier_integration_type": "GENERIC",      "carrier_integration_id": "string",      "bulk_ship_id": "string",      "fulfiller_team_name": "string",      "fulfiller_team_id": "string",      "merchant_team_name": "string",      "merchant_team_id": "string",      "assigned_warehouse_name": "string",      "assigned_warehouse_id": "string",      "line_item_image_urls": [        "string"      ],      "fulfillment_count": 0.1,      "unique_core_item_count": 0.1,      "total_core_item_quantity": 0.1,      "shipping_address_email": "string",      "shipping_address_phone": "string",      "shipping_address_zip": "string",      "shipping_address_country": "string",      "shipping_address_state": "string",      "shipping_address_city": "string",      "shipping_address_address2": "string",      "shipping_address_address1": "string",      "shipping_address_company": "string",      "shipping_address_name": "string",      "carton_name": "string",      "carton_id": "string",      "service_id": "string",      "carrier_id": "string",      "entirely_fulfillable": true,      "ready_to_ship": true,      "customer_note": "string",      "packer_notes": "string",      "shipping_method": "string",      "partially_fulfillable": true,      "is_partial": true,      "line_item_hash": "string",      "status": "CLOSED",      "order_id": "string",      "request_status": "UNSUBMITTED",      "synced_at": "2019-08-24T14:15:22Z",      "deliver_by": "2019-08-24T14:15:22Z",      "fulfill_by": "2019-08-24T14:15:22Z",      "fulfill_at": "2019-08-24T14:15:22Z",      "fulfilled_at": "2019-08-24T14:15:22Z",      "cancelled_at": "2019-08-24T14:15:22Z",      "remote_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "fulfillment_order_fulfillment_holds": [        {          "remote_id": "string",          "order_fulfillment_hold_id": "string",          "fulfillment_order_id": "string",          "created_by_user_id": "string",          "reason_notes": "string",          "reason": "AWAITING_PAYMENT",          "updated_at": "2019-08-24T14:15:22Z",          "created_at": "2019-08-24T14:15:22Z",          "id": "string"        }      ],      "ready_to_ship_issues": [        {          "id": "string",          "type": "PRODUCT_CONFIGURATION_ISSUES",          "description": "string"        }      ],      "active_lock": {        "fulfillment_type": "PICK_PACK",        "lock_owner": "string",        "acquired_at": "2019-08-24T14:15:22Z",        "expires_at": "2019-08-24T14:15:22Z",        "display_name": "string",        "team_id": "string",        "user_id": "string",        "user_email": "string",        "picking_session_id": "string",        "manual_fulfillment_id": "string",        "bulk_ship_id": "string",        "api_key_id": "string"      },      "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  }}