In general
The API type is REST and the data format is JSON.
Typical errors & their causes
Error | Explanation | Solution |
403 Forbidden | Missing permissions/token | Check API keys and user permissions |
422 Name is required to create locations | locations used without an existing location document | Remove locations unless importing with GPS locations |
405 Method Not Allowed (PUT /documents) | PUT without document ID | Use URL with document_id |
PUT error on translations | PUT does not support the translation object | Use the translation endpoint |
Best practices for integration
Always use external_id as the primary update key unless otherwise agreed.
Create custom attributes before sending data; otherwise they are ignored/rejected.
Use sandbox.prduct.com/data-model to:
Create attributes
Check model names and input types
For importers, location objects are documents, and they must be created before they can be referenced.
For domestic batches, locations should not be used.
I get error message "The type field is required..."
This can be cause by several errors:
The type filed is not filled out correctly.
Using the wrong end-point.
Trying to send HTML/text via a Json bearer token.
Add "-ContentType 'application/json' to the body.
Support and questions
If you encounter any issues or have questions along the way, feel free to contact us. Reach out via the chatbot in the lower-right corner or email us at [email protected]