Product Locator Format
When creating an order for a Shopify product, use theproductLocator
parameter with the Shopify product URL and variant ID:
shopify:<product-url>:<variant-id>
, where:
shopify:
is the prefix identifying this as a Shopify product<product-url>
is the full URL to the product page<variant-id>
is the unique variant ID for the specific product option (size, color, etc.)
Example Flow
1
Create the order
- Specify the recipient’s email
- Specify their shipping information
- Specify the payment method used
- Specify the product locator
For a full list of supported currencies, refer to the supported
currencies page.
2
Check order status
With all required information provided, the order’s response will include payment preparation details, as shown below.
Additional Information
- Monitor order statuses through the Developer Console
- Review the Order Lifecycle guide for detailed status handling
- Check this guide for details on supported currencies and payment methods
- Note: Delivery destinations are limited to regions supported by the Shopify store itself. The ability to ship to a specific address depends on the merchant’s shipping configuration.