Best Practices
The following is a list of best practices for JOOR's Brand API. We recommend implementing these functional and technical capabilities while building your API integration with JOOR for the best possible user experience.
General
- Provide a singular technical point of contact for integration-related work, issues, and troubleshooting.
- Provide the ability to test the integrations using JOOR’s Sandbox Account.
- Send JOOR the header (including endpoint URI) and body (JSON) details of specific API requests to help troubleshoot issues.
- Provide an interface with integration settings on the ERP accessible by the brand.
- Process and display REST API responses to users to allow for troubleshooting errors.
- Provide training to brand on ERP integration process with JOOR.
- Trigger all integrations automatically via a set schedule and manually on demand.
- Ability to store multiple API tokens, if an account is split into multiple JOOR profiles -- usually per division or company.
v4 API Best Practices
JOOR v4 API is relatively new. Our QA team has thoroughly tested it; however, please refrain from pushing our limits and follow the below guidelines when making requests.
- Use unitary requests whenever possible; yes, v4 is a bulk API; however, it's much easier for JOOR and the client support teams to troubleshoot a request with a single object.
- When sending multiple requests to the same endpoint, please wait for the response to the previous request before sending a new one.
Styles
- Create, update, and delete styles.
- Support multiple price types and currencies for wholesale and retail prices.
- Deactivate sizes.
- Delete colors.
- Create and assign custom style fields (style tags).
- Send JOOR Categories when creating styles.
- Send case pack sizes. Note: Casepacks need to be set up in JOOR before sending.
- Use standard ISO 3-character currency codes.
- Send the same price type currencies and labels for styles and customers.
- Allow users to manually create linesheets in JOOR (using the delivery_overwrite field).
- Create linesheets in JOOR based on the brand’s criteria (season, delivery, etc.).
- Exclude colors from linesheets per season.
- Drop styles from linesheets.
Inventory
- Load inventory using Color, Size, and Style ID or Style Identifier if splitting styles by data other than Style Number.
- Provide an option for a brand to send all inventory (Overwrite) or updates only (Update).
- Support multiple warehouses and availability dates (Immediate and future).
- Send inventory for case pack sizes.
Images
- Send images as non-password protected URLs.
- Send style, color, and swatch images to JOOR as desired by the brand.
Connections
- Utilize the Bulk Connections endpoint to create and update customers.
- Create Doors based on shipping addresses.
- Assign Discounts at the Order or Item level.
- Assign warehouses to customers.
- Assign Sales Reps to customers.
- Use standard ISO 3-character currency codes.
- Send the same price type currencies and labels for styles and customers.
Orders
- Import orders from JOOR (perform a valid import to ERP)
- Store JOOR’s Order ID for reference in the ERP.
- Update order shipping data on JOOR.
- Update order payment data on JOOR.
- Update order line item data on JOOR if it changes on the ERP.
- Update customer order data on JOOR if it changes on the ERP.
- Import the same order more than once to overwrite data in ERP.
- Import all style, customer, and order data from JOOR.
- Import order and line item level discounts.
Updated about 3 years ago