Get Fulfillment Count

Retrieves the total number of fulfillments for a specific order.

🔒

Requires read_order access scope. More access scope

The Fulfillment Total Count API retrieves the total number of fulfillments for a specific order. This enables users to query the count of fulfillments created or updated within a given date range.

This API is especially useful for:

  1. Monitoring fulfillment activities for an order.
  2. Validating the number of fulfillments processed over time.
  3. Filtering fulfillments based on creation or update timestamps.

Request Parameters

Public Request Parameters

📘

Path Parameters

ParameterTypeRequiredExampleDescription
order_idstringYes633130-00000012Unique identifier for the order.

Query Parameters

ParameterTypeRequiredExampleDescription
created_at_minstringNo2016-01-18T23:41:00ZFilter fulfillments created at or after this date (ISO-8601).
created_at_maxstringNo2016-01-18T23:41:00ZFilter fulfillments created at or before this date (ISO-8601).
updated_at_minstringNo2016-01-18T23:41:00ZFilter fulfillments updated at or after this date (ISO-8601).
updated_at_maxstringNo2016-01-18T23:41:00ZFilter fulfillments updated at or before this date (ISO-8601).

Response Explanation

Public Response Parameters

📘

Success Response

FieldTypeDescriptionExample
codestring"success"Response status code
messagestringDescriptive message of the response
data.countint321Total number of fulfillments.

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!