Stock Movements API Overview

This API is for use with ZFS only.

Use the Stock Movements API to track inbound and outbound receive processes or cross-border movements of ZFS products for Intrastat declarations.

The retention time for data in this service is 100 days. After that, data may be deleted without notice.

Stock Movements API Scopes

Many zDirect APIs require clients to have specific permissions or scopes for read or write access. You may assign scopes to your apps in the "Applications" section of the zDirect Portal.

For more information on configuring app scopes, see the Applications section of our zDirect Portal guide.

Required scopes are:

Endpoint scope
/zfs/returned-items zfs/returned-item/read
/zfs/received-items zfs/received-item/read
/zfs/intra-community-movements zfs/icm-reports/read

Rate Limiting

Each endpoint may only make the following number of requests per second:

Endpoint req/s
/zfs/returned-items 100
/zfs/received-items 20
/zfs/liquidated-items 5
/zfs/intra-community-movements 10

For more information, see Rate Limiting.

Sandbox Behavior

When calls are made to the Stock Movements API in the sandbox environment, we run basic validation on the request, and if it is well formed, return appropriate sample values.

For more information, see Sandbox Testing in our Getting Started Guide.

Additional Resources

Contact Support