Faire has now supporting shop currencies in addition to USD and the API changes are being made to both v1 and v2 endpoints.
With a shop currency other than USD, all the existing price fields will be null. Hence, Faire has started replacing the price fields only for API v2 endpoints and it has deprecating the API v1 endpoints, and no maintenance will be offered going forward. Hence, it is recommended and required that all the Faire administrators migrate their API v1 endpoints to v2 at the earliest.
As part of this migration, Celigo will remove all the Faire API v1 endpoints from the integrator.io with the 2022.R4 release, scheduled for November 08, 2022.
This article explains how to find the Faire v1 endpoints in the existing flows and replace them to API v2 endpoints.
Additional reference: Migrating from the v1 API
Contents
- Faire v1 endpoints with v2 replacement endpoints
- Faire price fields with replacement fields
- Changes need to be made in integrator.io
Faire v1 endpoints with v2 replacement endpoints
Below is the list of export replacement endpoints:
| v1 endpoints | v2 endpoints |
|---|---|
| Get All Products | Get All Products |
| Get A Product By ID | Get A Product By ID |
| Get All Taxonomy Types | Get All Taxonomy Types |
| Get All Orders | Get All Orders |
| Get A Single Order By ID | Get A Single Order By ID |
| Get Brand Profile | Get Brand Profile |
Below is the list of import replacement endpoints:
| v1 endpoints | v2 endpoints |
|---|---|
| Create a Product Option | Create a Product Variant |
| Update a Product Option | Update a Product Variant |
| Delete a Product Option | Delete a Product Variant |
| Update Inventory Levels | Update inventory levels by variant SKUs |
| Accept an Order | Accept an Order |
| Add Shipments to an Order | Add Shipments to an Order |
| Delete a Product | Delete a Product |
Faire price fields with replacement fields
Below is the list of price fields that will be null when the shop currency is not USD.
Product Variants:
| Fields that might be null | Replacement/suggested fields |
|---|---|
| retail_price_cents | Retail_price.amount_minor (field inside Price array) |
| wholesale_price_cents | Wholesale_price.amount_minor (field inside Price array) |
Order Items:
| Fields that might be null | Replacement/suggested fields |
|---|---|
| price_cents | price.amount_minor |
| tester_price_cents | tester_price.amount_minor |
Shipments:
| Fields that might be null | Replacement/suggested fields |
|---|---|
| maker_cost_cents | maker_cost.amount_minor |
Payout Costs:
| Fields that might be null | Replacement/suggested fields |
|---|---|
| payout_fee_cents | payout_fee.amount_minor |
| commission_cents | commission.amount_minor |
Example: If you have changed your shop currency from USD to another currency and you are using the v1 and price_cents field to pull up the prices from the order items, either you will be getting a null value or no price_cents field in the response. Faire didn’t introduce any replacement price field for it in v1. But in v2, instead, they have introduced a replacement currency field called price.amount_minor for retrieving the prices of an order item.
Changes need to be made in integrator.io
A. Find v1 endpoints in the existing flows
To find each import and export that uses a Faire connection:
- Sign in to your integrator.io account.
- Navigate to Resources > Connections.
- Search for an existing Faire connection, from the Actions overflow ... menu, select Used by. A list of all items that use this connection appears.
- Right-click the first flow step in the list and select your browser’s option to open it in a new tab.
- Review the configuration for any of the v1 endpoints listed in the above table:
When you encounter a v1 endpoint, first copy the path parameter and search parameter values to a reference document to back them up when replacing the endpoints.
B. Update flows to use replacement v2 endpoints
For each export and import containing a v1 endpoint, replace it with the v2 endpoint by referring to the Faire v1 endpoints with v2 replacement endpoints section and update the flow by mapping with respective endpoints.
Comments
0 comments
Please sign in to leave a comment.