When you configure an export, import, or other type of flow step using the prebuilt Faire connector, you can select any of the API operations listed below, organized by API type.
Note
If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Faire API documentation. You can also create a composite endpoint for this application in HTTP mode.
| Resource | API endpoint | Export | Import |
|---|---|---|---|
| Brands | Get brand profile | X | |
| Images | Upload image | X | |
| Order items | Backordering items | X | |
| Orders | Get all orders | X | |
| Get a single order by ID | X | ||
| Accept an order | X | ||
| Add shipments to an order | X | ||
| Cancel an order | X | ||
| Prepacks | Get all prepacks for a product | X | |
| Get a prepack for a product | X | ||
| Add a prepack to a product | X | ||
| Delete a prepack | X | ||
| Add multiple prepacks to a product | X | ||
| Product variant inventory | Get inventory by variant IDs | X | |
| Get inventory by SKUs | X | ||
| Update inventory by variant IDs | X | ||
| Update inventory by SKUs | X | ||
| Product variants | Create product variant | X | |
| Update a product variant | X | ||
| Delete a product variant | X | ||
| Update inventory levels by variant IDs (Deprecated) | X | ||
| Update inventory levels by variant SKUs (Deprecated) | X | ||
| Delete image from variant | X | ||
| Products | Get all products | X | |
| Get a product by ID | X | ||
| Get all taxonomy types | X | ||
| Create a product | X | ||
| Update a product | X | ||
| Update product's variation option sets | X | ||
| Delete a product | X | ||
| Product variant prices | Update product prices by product variant IDs | X | |
| Update product prices by SKUs | X | ||
| Retailers | Get retailer public profile | X |
Available DI objects
The following objects are available when using Faire as a source in Celigo Data Integration (DI).
Primary key: All Faire DI objects use a top-level string id as the primary key. Faire returns a unique id on every object it returns, so id is the consistent key across resources.
Note
Faire does not expose hard deletes through its API — orders move through lifecycle state transitions (for example, canceled) and products are deactivated or discontinued rather than physically removed, and remain retrievable via the API.
Response schemas
Click an object below to view its response fields and delta configuration.
Orders — Get all orders
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updated_at_min = {{{encodeURI lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss.SSS[Z] |
Response schema:
| Field | Type |
|---|---|
id |
string (Primary key) |
display_id |
string |
state |
string |
created_at |
string |
updated_at |
string |
ship_after |
string |
original_order_id |
string |
retailer_id |
string |
source |
string |
purchase_order_number |
string |
estimated_payout_at |
string |
notes |
string |
has_pending_retailer_cancellation_request |
boolean |
sales_rep_name |
string |
expected_ship_date |
string |
address |
object |
address.name |
string |
address.address1 |
string |
address.address2 |
string |
address.city |
string |
address.state |
string |
address.postal_code |
string |
address.country_code |
string |
address.phone_number |
string |
address.company_name |
string |
payout_costs |
object |
shipments |
objectarray |
shipments.order_id |
string |
shipments.maker_cost_cents |
number |
shipments.carrier |
string |
shipments.tracking_code |
string |
shipments.created_at |
string |
shipments.updated_at |
string |
shipments.shipping_type |
string |
shipments.shipping_label_url |
string |
items |
objectarray |
items.id |
string |
items.product_id |
string |
items.variant_id |
string |
items.sku |
string |
items.product_name |
string |
items.variant_name |
string |
items.quantity |
number |
items.includes_tester |
boolean |
items.state |
string |
items.price_cents |
number |
items.created_at |
string |
items.updated_at |
string |
items.price |
object |
items.prices |
objectarray |
Products — Get all products
Delta configuration: use it to request incremental data.
| Setting | Value |
|---|---|
| Delta filter | updated_at_min = {{{encodeURI lastExportDateTime}}} |
| Date format | YYYY-MM-DDTHH:mm:ss.SSS[Z] |
Response schema:
| Field | Type |
|---|---|
id |
string (Primary key) |
name |
string |
short_description |
string |
description |
string |
lifecycle_state |
string |
unit_multiplier |
number |
minimum_order_quantity |
number |
per_style_minimum_order_quantity |
number |
made_in_country |
string |
allow_sales_when_out_of_stock |
boolean |
preorderable |
boolean |
brand_id |
string |
created_at |
string |
updated_at |
string |
taxonomy_type |
object |
taxonomy_type.id |
string |
taxonomy_type.name |
string |
preorder_details |
object |
preorder_details.order_by_date |
string |
preorder_details.keep_active_past_order_by_date |
boolean |
preorder_details.expected_ship_date |
string |
preorder_details.expected_ship_window_end_date |
string |
variant_option_sets |
objectarray |
variant_option_sets.name |
string |
variant_option_sets.values |
stringarray |
images |
objectarray |
images.url |
string |
variants |
objectarray |
variants.id |
string |
variants.sku |
string |
variants.gtin |
string |
variants.lifecycle_state |
string |
variants.tariff_code |
string |
variants.retail_price_cents |
number |
variants.wholesale_price_cents |
number |
variants.available_quantity |
number |
variants.backordered_until |
string |
variants.prices |
objectarray |
variants.options |
objectarray |
variants.images |
objectarray |
variants.measurements |
object |