Count locations

Count all locations for shipping, inventory, and order fulfillment.

🔒

Requires read_shop_navigation access scope. More access scope

Retrieves the total count of all available locations used for shipping, inventory management, and order fulfillment operations.

This API is particularly valuable for:

  1. Obtaining real-time location quantity metrics
  2. Tracking location inventory growth trends
  3. Generating analytical reports and system dashboards

Request Parameters

Public Request Parameters

📘

Response Explanation

Public Response Parameters

📘

Successful Response

ParameterTypeExampleDescription
codestring"success"Operational status indicator
messagestring"Count retrieved"Execution result notification
data.countstring"150"Aggregate count of existing locations

Example Response

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!