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:
Monitoring fulfillment activities for an order.
Validating the number of fulfillments processed over time.
Filtering fulfillments based on creation or update timestamps.
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "Unable to find resource"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
String
"store is not active"
Indicates an error encountered during the process
Error Detail
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
422
created_at_max time format error
The created_at_max field is not in a valid time format.(e.g., not ISO8601).
{"errors": ["created_at_max time format error"]}
updated_at_min time format error
The updated_at_min field is not in a valid time format.(e.g., not ISO8601).
{"errors": ["updated_at_min time format error"]}
500
System error
Missing order_id
{"errors": ["System errort"]}
404
provided order_id is not existing
provided order_id is not existing
{"errors": ["Unable to find resource"]}
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
