@import url('https://fonts.googleapis.com/css2?family=Poppins:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap');

html, body, h1, h2, h3, h4, h5, h6, p, span, a{
  font-family: Poppins;
}
#navbar {
  background: #000000;
}
#navbar .bg-background-light{
  background: #000000;
}
#navbar #search-bar-entry {
  background: rgb(var(--background-dark)/var(--tw-bg-opacity))
}
#navbar [id^='radix'].bg-background-light{
  border-radius: 8px;background: #fff;color: rgb(var(--gray-500));border:none
}
#navbar .dark\:text-gray-300 {
  color: rgb(var(--gray-300));
}
#navbar .dark\:bg-primary-light {
  --tw-bg-opacity: 1;
  background-color: rgb(var(--primary-light) / var(--tw-bg-opacity));
}
#navbar .text-gray-800 {
  color:rgb(var(--gray-200))
}
#navbar .text-gray-600{
  color:#d4d4d4;
}
#topbar-cta-button .rounded-full, #topbar-cta-button .rounded-full:is(.dark *)
{
	border-radius: 31px;
	/*background: rgba(249, 160, 255, 0.45);*/
  background: #c732c0;
	box-shadow: 0px 7.57px 30.28px 0px rgba(0, 0, 0, 0.08);
  border: none;
}
#topbar-cta-button .dark\:text-primary-light, #topbar-cta-button .dark\:text-primary-light:is(.dark *){
  color: #FFF;
  text-align: center;
  font-size: 14px;
  font-style: normal;
  font-weight: 500;
  line-height: 20px;
  letter-spacing: -0.084px;
}
.bodyContainer{
  max-width:63rem;
  margin: auto;
  background: transparent;
}
.bodyFull{
  background: url("images/hero-background-unmasked-1.svg");
  position: relative;
  overflow: hidden; 
}

.bodyFull:is(.dark *), .bodyContainer:is(.dark *){
  background-color: transparent;
}
.box-full{
  border-radius: 8px;
  box-shadow: 0px 7.57px 30.28px 0px rgba(0, 0, 0, 0.08);
  padding: 16px 20px;
}
.box-full:is(.dark *){
  background-color: #4d354d;
  border:1px solid rgba(255, 255, 255, 0.20);
}
button p{
  font-size:18px;
}
button .bg-primary-light{
  background-color: #121213;
}

.twocol-cntr {
  width: 75%;
  margin: auto;
  margin-top: 1rem;
}
.gap-x-4 {
  column-gap: 1rem;
  row-gap: 1rem;
}
.pink-boxes .card.block{
  background-color:#fff;
  border: 1px solid #D9ACD9;
  height:161px;
}
.pink-boxes .card.block h2{
  font-size:28px;font-weight: 300;
}
.my-2{
  margin:0;
}


.pink-boxes.dark\:bg-background-dark:is(.dark *){
  background-color: #0c0a0f !important; 
  z-index: -1;
  border-radius: 15px;
}
.pink-boxes.dark\:bg-background-dark:is(.dark *) .card.block{
  background-color:transparent;
  border: 1px solid #494949;
  position:relative;
}
.three-col.dark\:bg-background-dark:is(.dark *), .twocol-cntr.dark\:bg-background-dark:is(.dark *){
  background-color: #0c0a0f !important; 
  z-index: -1;
  border-radius: 15px;
}
.three-col.dark\:bg-background-dark:not(.dark *), .twocol-cntr.dark\:bg-background-dark:not(.dark *){
  background-color: #fff !important; 
  z-index: -1;
  border-radius: 15px;
}
.bg-primary{
  background-color: rgb(var(--gray-950) / var(--tw-bg-opacity));
}
.image-boxes h2{
  font-size: 24px;
  font-weight: 600;
  line-height: 32px;
  letter-spacing: -0.2px;
}
.subtitle{
  text-align: center;
  font-size: 20px;
  font-style: normal;
  font-weight: 400;
  line-height: 28px; 
  letter-spacing: 0.04px;
  width:70%;
  margin:auto;
}
.spacer{
  height:80px;
}

.resource-boxes{
  text-align: center;
}
.resource-boxes .dark\:bg-background-dark:is(.dark *){
  background-color: #121213;
}
.bodyContainer hr{
  border-color:rgb(227, 223, 226);
}
.bodyContainer:is(.dark *) hr{
  border-color:#27272A;
}
.col-lg-6{
  width:50%;
}
.footer{
  padding-bottom:2.5rem;
  display: flex;
  background:transparent;
}
.footer .dark\:bg-background-dark:is(.dark *){
  background-color: transparent;
}
.footer li, .footer p{
  font-size: 14px;
  font-style: normal;
  font-weight: 600;
  line-height: 24px;
  letter-spacing: -0.084px;
  margin-top: 12px;
}
.footer li a {
  color: #D037C5;
}
.footer .updated.col-lg-6{
  display: flex;
  justify-content: flex-end;
}
.fa-thin.fa-question-circle{
  mask-image: url(
    "https://mintlify.b-cdn.net/v6.6.0/regular/question.svg"); 
  mask-repeat: no-repeat; 
  mask-position: center center;
}
.fa-thin.fa-headphones{
  mask-image: url(
    "https://mintlify.b-cdn.net/v6.6.0/regular/headphones.svg"); 
  mask-repeat: no-repeat; 
  mask-position: center center;
}
.fa-thin.fa-list{
  mask-image: url(
    "https://mintlify.b-cdn.net/v6.6.0/regular/list.svg"); 
  mask-repeat: no-repeat; 
  mask-position: center center;
}
.fa-thin:is(.dark *){
  background-color: #fff;
}
/* Color Overrides */
.footer.bg-background-light{
  background-color:transparent;
}
.dark\:text-gray-400:is(.dark *){
  color:#d4d4d4;
}

if (!localStorage.getItem('isDarkMode')) {
    localStorage.setItem('isDarkMode', 'true'); 
    document.documentElement.classList.add('dark'); 
  }

Retrieve a list of all available compliance reports for a given retailer.

List compliance reports

A detailed description of the compliance report

Unique identifier for the compliance report

The interval at which the compliance report is generated, such as monthly or quarterly.

Periods for which the compliance report is applicable.

The start date and time of the compliance report in UTC format.

Bearer

Fabric

Home

Getting Started

Orders & Inventory

Product Catalog

Offers

Dropship

Cart & Checkout

Integrations

Platform

Store Fulfillment

Release Notes

API Reference

Recipes

Request Demo

fabric’s API-first platform gives developers the control and flexibility to easily build from scratch or integrate with the existing stack, to compose the perfect commerce experiences.

fabric Homepage

Welcome to the fabric Developer Portal

Overview

Orders

Inventory

Data Security

Terms and Conventions

Glossary

Feature Descriptions

Fulfillment AI

Product Catalog AI

Adding Team Members

API References

API Authentication

Getting Started with fabric APIs

Making your first API request

Example

Using Developer Portal

Learn how we protect customer data, user data, and the reliability of our commerce services and applications.

Security and Compliance

Identifiers

Concepts

Getting Started with System Apps

System App Authentication

Getting Started with User Apps

Customizing Customer Login

User App Authentication

Migrate Existing Users to a User App

Best Practices for Customizing Login Flows

Authentication Endpoints

This endpoint allows apps to fetch access tokens. For user apps, use this endpoint after the `/authorize` endpoint and the subsequent callback. For user apps this endpoint supports generation of access token from authorization code or from refresh token, sent in the previous `authorize` endpoint's callback. For system apps this endpoint can directly be used to get an access token, no prior `/authorize` end point call is needed. NOTE: Fetching a token for a system app via the browser on our developer portal WILL NOT WORK as browser requests to the token endpoint must use PKCE. Instead, send the request through a server side/native method and ensure the 'Origin' header isn't present.

Fetch access token

Use this endpoint to authenticate user apps using fabric Identity. When calling this endpoint, the immediate response will be a browser redirect to the hosted Login page configured in fabric Identity. After successful authentication of the user on the hosted Login page, fabric Identity will redirect back to the user app using the provided `redirect_uri`. This endpoint supports both authorization code flow with and without Proof of Code Exchange (PKCE). **Note**: This endpoint isn't required for system app authentication (refer to `/token` endpoint instead)

Authorize user apps with and without PKCE

Build a centralized source of order, inventory, and warehouse information with fabric Orders.

Creating an Order

Viewing Orders

Filtering Orders

Viewing Allocations

Viewing Shipments

Viewing Invoices

Adding Products to an Existing Order

Updating a Shipping Address

Processing returns

Creating Appeasement Refunds

Processing Exchanges

Canceling Items in an Order

Exporting Orders

Order Fulfillment Logic Overview

Creating a Rule Set

Updating a Rule Set

Activity Log

Use the Order Settings menu to manage order attributes, shipping methods, policies, alerts, backorders, and preorders.

Order Attributes

Shipping Methods

Backorder & Preorder Settings

Order Policies

See the stock of goods across locations all in one spot

Locations Overview

Creating a Location

Configuring Scheduled Closures

Importing Locations

Exporting Locations

Networks Overview

Create a Network

Zones

Geographic Regions

Orders (3.0.0)

Importing order and inventory data

Inventory Setup

Order Fulfillment

Order Exchange

Order Return

List of Webhook Events

Orders FAQ

Getting Started with Lists

Shoppers need to remove unwanted or irrelevant shopping lists. With this endpoint, they can delete a list by list ID.

Delete a shopping list by ID

Shoppers may want to periodically review their shopping lists and ensure they are up to date. This endpoint gets a paginated response of shopping lists by user ID. For each list, you can view user ID, list ID, list name, type, notes, custom attributes (if any), as well as time of list creation and update. **Note**: 1. You can refine the results by specifying `offset` and `limit`. When they are not specified, you will get up to 10 records. 2. To view items in a list, refer to *Get lists with items* endpoint - `GET /lists/users/{userId}/actions/get-list-details-with-items`.

Get shopping lists of a user

Shoppers like to update their shopping lists and keep them relevant. By specifying list ID, this endpoint lets your shoppers update their shopping list details such as list name, list type, notes, and custom attributes.

Update a shopping list by ID

Shoppers often choose to save their desired products in shopping lists to purchase later when they are ready or to take advantage of discounts when they are available. This endpoint creates a new shopping list. The response includes a list ID, which is required for subsequent calls to get, update, or delete this shopping list. **Note**: Items can't be added when the shopping list is initially created. To add items, use the *Add items to list* endpoint - `POST /lists/{listId}/actions/add-or-update-list-items`.

Create shopping list

Get details of a shopping list by ID, along with the number of items in it.

Get a shopping list by ID

By specifying list ID, you can get shopping list details along with its items.

Get shopping list and its items

Shoppers may periodically review their shopping lists and their associated items. This endpoint gets shopping lists and associated items. For each list, you can view list ID, list name, user ID, list type, notes, custom attributes, items count, times of list creation and list update, as well as item details.

Get shopping lists of a user along with associated items

Shoppers may periodically review their shopping list to check for discounts or when they are ready to make a purchase. This endpoint gets a paginated list of items by list ID. You can refine the results by specifying `offset` and `limit`. When they are not specified, you will get up to 10 records.

Get shopping list items by list ID

Over time, shoppers' preferences may change, or they might have added an item to their shopping list by mistake. This endpoint lets your shopper remove one or more products from the specified shopping list.

Delete items from shopping list

Once a shopping list is created, shoppers can add new item to it or update existing ones. This endpoint is used to add and update items in a list. - If the specified `sku` is not in the list, a new item is added to the list with the given `quantity`. - If the specified `sku` is already in the list, its current quantity is updated based on the given `incQuantity`. **Note**: At least one item must be in the request body.

Add or update items in a shopping list

At checkout, customers choose their preferred shipping method based on delivery timelines and costs. Moreover, it may be necessary for you to review available shipping methods to ensure they're current and accurate. To support these scenarios, you must get the latest shipping methods. This endpoint gets shipping methods based on given filter conditions.

Find shipping methods

When a particular shipping service is discontinued or certain shipping methods have become redundant or non-compliant with existing regulations, you may want to remove them so they're not shown to shoppers. This endpoint deletes a shipping method by ID.

Delete shipping method

On your storefront, shipping methods determine how products are delivered to your customers. Some of the common shipping methods are domestic, international, free shipping, and express delivery. This endpoint is used to create a new shipping method. In the response, you will also get a shipping method ID, which will be required for subsequent calls to get, update, and delete this shipping method.

Create shipping method

When an order is placed, the selected shipping method is stored as part of order details. You may need to review them for order related queries. This endpoint gets details of a single shipping method by ID.

Get shipping method

To comply with legal regulations and for other purposes, it may be necessary to update shipping rates or delivery timelines. With this endpoint, you can update shipping details by ID. This completely replaced existing information.

Update shipping method

You may want to determine what items are in a specific shipping method, to calculate shipping costs, verify the eligibility of items for specific shipping methods, or display the list of items to shoppers during the checkout process.This endpoint is used to get item IDs for a given shipping method.

Get item IDs for given shipping method

You may want to offer different shipping options for items based on their weight and dimensions, or you may want to offer promotional shipping rates based on order value, customer loyalty, etc. This endpoint lets you add items to an existing shipping method so that shoppers can see the options.

Add items to shipping method

Certain items may need to be removed from a shipping method when they're discontinued, new shipping restrictions are imposed on hazardous items, or when they're not eligible for current promotions. Using this endpoint, you can delete one or more items from the given shipping method.

Delete items from shipping method

You may need to periodically review shipping methods associated with an item, either to answer related queries or to verify they're up to date. This endpoint gets shipping methods for the given item ID.

Get shipping methods

Getting Started with Imports

Upload bulk file by specifying file name. Successfully uploading the file triggers the import process, which is an event-driven extraction of the file's data to update the respective resource's system.

Upload bulk file to import data

Get uploaded files that match specified criteria. Returned as paginated records.

Get uploaded files that match specified criteria

Get uploaded file status and details by specifying `importId`.

Get uploaded file status and details

Getting Started with Exports

Get details of a specific export job by specified `exportId`.

Get export job by exportId

Get a paginated list of all the export jobs based on the filter criteria specified in the request body.

Get export jobs by query

Initiate data export by the given filter criteria.

Export data by query

Get the list of file headers for a given module.**Note:** File headers are basically the column headers or titles of the exported document.

Get file headers by module

Getting Started with Orders

This endpoint creates a new order in the fabric Orders (OMS) system, regardless of whether it originates from fabric CnC service or an external system. The response includes an order ID, which is required for subsequent calls such as updating pickup information, getting order details, verifying eligibility for order cancellations, returns, exchanges, as well as creating appeasements, and processing order returns, cancellations, and exchanges.

Create new order

As a merchant, you may need to review or monitor an order to answer customer inquiries, resolve a complaint or for analytics and reporting. With this endpoint, you can get order details by order number. **Note**: If you do not have the order number, use the corresponding order ID-based endpoint - `GET /orders/{orderId}`.

Get order by order number

As a merchant, you may need to review or monitor an order to answer customer inquiries, resolve a complaint, or for analytics and reporting. With this endpoint, you can get order details by order ID. **Note**: If you do not have the order ID, use the corresponding order number-based endpoint - `GET /orders/order-number/{orderNumber}`.

Get order by order ID

Customers may want to review their past orders or, as merchants, you may have to answer queries related to past orders, and analyze sales. To support the previously mentioned use cases, this endpoint searches for orders based on filter conditions specified in the request body. By using `offset` and `limit` you can refine the search results. When they are not specified, you will get up to 10 results.

Find orders

The following endpoint is used to update attributes by order number.

Update Shipping information for an existing order by order number

The update attributes endpoint is used to update order attributes using the order ID. Attributes can be updated in the integration layer to modify external system related information.

Update Order Attributes

In many scenarios, customer details may change over time. For example, a customer might change their email, phone, or company affiliation. By providing the order IDs and the updated customer details, this endpoint facilitates updating customer info for the given order IDs. This ensures order-related communication reaches the customer and they get timely customer service.

Update customer details for given order IDs

Customers can choose to either have their order delivered to them or opt to pick up from a store or warehouse. In a Buy Online Pickup in Store (BOPIS) scenario, there may be situations when the primary pickup person has changed. This endpoint allows for the updating pickup person details in BOPIS, ensuring that the most up-to-date information is available.

Updates order pick-up details

When processing refunds, credits such as a gift card may be offered to customers for various reasons such as damaged products, later deliveries, or other qualifying factors as per your policy. This endpoint checks the credits eligibility by order number, allowing you to manage credits effectively and provide appropriate compensation to eligible customers.

Check credits eligibility by order number

Customers may want exchange an item because of size, fit, color, or style preferences. Before processing exchange, it's crucial to verify whether the item is eligible for exchange as per your policy. This endpoint gets the exchange eligibility by order number. You can additionally specify `lineItemId` to get eligibility for a specific item. **Note**: If you do not have the order number, but have the order ID, use the order ID-based endpoint - `POST /orders/{orderId}/actions/check-exchange-eligibility`.

Get order exchange eligibility by order number

This endpoint checks for the appeasement eligibility of an order by order number.

Check appeasement eligibility by order number

This endpoint checks for the appeasement eligibility of an order by orderId.

Check appeasement eligibility by order ID

Getting Started with Frauds

If an order is suspected to be fraudulent, it is immediately placed on hold for verification. After verification, if it's confirmed as fraudulent, this endpoint is used to cancel the order by order number. **Note**: If you don't have order number, use the corresponding order ID-based endpoint - `POST /orders/{orderId}/actions/fraud-cancel`.

Cancel fraud order by order number

If an order is suspected to be fraudulent, it is immediately placed on hold for verification. After verification, if it is confirmed as fraudulent, this endpoint is used to cancel the order. **Note**: If you do not have order ID, use the corresponding order number-based endpoint - `POST - /orders/order-number/{orderNumber}/actions/fraud-cancel`

Cancel fraud order by order ID

If an order is suspected to be fraudulent, it is immediately placed on hold for verification. After verification, if it is confirmed as non-fraudulent, this endpoint is used to release the order from hold, by order ID, so that it can be processed. **Note**: When you don't have order ID, use the corresponding order number-based endpoint - `POST /orders/order-number/{orderNumber}/actions/fraud-release`.

Release fraud order by order ID

If an order is suspected to be fraudulent, it is immediately placed on hold for verification. After verification, if it is confirmed as non-fraudulent, this endpoint is used to release the order from hold, by order number so that it can be processed. **Note**: When you don't have order number, use the corresponding order ID-based endpoint - `POST /orders/{orderId}/actions/fraud-release`.

Release fraud order

Getting Started with Notifications

This endpoint gets notification acknowledgment from external service.

Get acknowledgment receipt for notification

When an order is placed, the first notification is automatically sent to shopper. If the first notification isn't delivered for reasons such as incorrect email or server issues, this endpoint resends notification for specific events.

Merchants

Merchant API Endpoints

Suppliers

List compliance reports

Authorizations

Path Parameters

Response