# Fabric ## Docs - [Welcome to the fabric Developer Portal](https://developer.fabric.inc/home.md): 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. - [Create address](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/addresses/create-addresses.md): Adds a billing address to the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Delete address](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/addresses/delete-addresses.md): Removes the billing address associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Address ID from the [Create address](/v3/cart-and-checkout/api-reference/carts-v3/addresses/create-addresses) endpoint is used in the path parameter. - [Get address](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/addresses/get-addresses.md): Gets the billing address associated the cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Address ID from the [Create address](/v3/cart-and-checkout/api-reference/carts-v3/addresses/create-addresses) endpoint is used in the path parameter. - [Update address](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/addresses/update-addresses.md): Updates the billing address associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Address ID from the [Create address](/v3/cart-and-checkout/api-reference/carts-v3/addresses/create-addresses) endpoint is used in the path parameter. - [Add cart attributes](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/cart-actions/add-attributes.md): Partially updates attributes of your choice in the cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Delete cart attributes](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/cart-actions/delete-attributes.md): Partially deletes attributes of your choice associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Merge carts](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/cart-actions/merge.md): This endpoint merges two carts together. Specify one cart in the path parameter and the second cart in the request body. To learn more about merge cart behaviors, you can check out the [Merge Cart Behaviors](/v3/cart-and-checkout/api-reference/carts-v3/merge-carts-behaviors) page. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Create adjustment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/carts-adjustments/create-adjustments.md): Creates adjustments to the corresponding cart. This is useful when a price needs to be adjusted by a CSR agent. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Remove adjustment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/carts-adjustments/delete-adjustments.md): Removes an adjustment made to the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Adjustment ID from the [Create adjustment](/v3/cart-and-checkout/api-reference/carts-v3/carts-adjustments/create-adjustments) endpoint is used in the path parameter. - [Update adjustment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/carts-adjustments/update-adjustments.md): Updates the adjustments made to the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Adjustment ID from the [Create adjustment](/v3/cart-and-checkout/api-reference/carts-v3/carts-adjustments/create-adjustments) endpoint is used in the path parameter. - [Create an empty cart](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/carts/carts.md): Use this endpoint to create a new cart. **Default Configurations**: To create a cart with default configurations, send a request with an empty body. **Provided Configurations**: To create a cart with provided configurations, include the configurations in the request body. To learn more about configuration behaviors, visit the [Configuration Behaviors](/v3/cart-and-checkout/api-reference/carts-v3/configuration-behaviors) page. - [Delete cart](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/carts/delete-cart.md): Removes the cart corresponding to the provided cart ID. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Get the provided cart](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/carts/get-cart.md): Retrieves the cart information corresponding to the provided cart ID. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Search for multiple carts](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/carts/search.md): Returns a list of carts based on the search criteria. - [Sequence calling](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/carts/sequence.md): Use this endpoint to execute multiple cart-related operations with a single request. This allows you to perform various actions such as creating a cart, adding items, and checking out in a single API call. **Note:** The order of operations matters since IDs are carried over from call to call. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Update cart](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/carts/update-cart.md): Updates the cart information corresponding to the provided cart ID. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Configuration Behaviors](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/configuration-behaviors.md) - [Add Coupon](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/coupons/add-coupons.md): Adds a coupon to the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Coupon ID, which is the coupon code generated when [creating a custom coupon](/v3/cart-and-checkout/api-reference/carts-v3/carts-adjustments/create-adjustments) in Copilot, is used in the path parameter. - [Removes Coupon](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/coupons/remove-coupons.md): Removes the existing coupon from the cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Coupon ID is a coupon code generated when [creating a custom coupon](/v3/cart-and-checkout/api-reference/carts-v3/carts-adjustments/create-adjustments) in Copilot and is used in the path parameter. - [Add customer attributes](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/customer/add-customer-attributes.md): Partially updates attributes of your choice in the customer object associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Delete customer attributes](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/customer/delete-customer-attributes.md): Partially deletes attributes of your choice in the customer object associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Update customer](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/customer/update-customer.md): Updates the customer information in the cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Configuring Adjustment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/developer-guide/configuring-adjustments.md) - [Configuring Fees](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/developer-guide/configuring-fees.md) - [Configuring Fulfillment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/developer-guide/configuring-fulfillment.md) - [Configuring Order Drafts](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/developer-guide/configuring-order-drafts.md) - [Configuring Payment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/developer-guide/configuring-payment.md) - [Configuring Search Cart](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/developer-guide/configuring-search-cart.md) - [Configuring Split Line Items](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/developer-guide/configuring-split-line-items.md) - [Configuring Taxes](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/developer-guide/configuring-taxes.md) - [Getting Started with fabric Carts API](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/developer-guide/getting-started.md) - [Create fee](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fees/create-fees.md): Creates a fee that is applied to the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Delete fee](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fees/delete-fees.md): Removes a fee from the cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Fee ID from the [Create fee](/v3/cart-and-checkout/api-reference/carts-v3/fees/delete-fees) endpoint is used in the path parameter. - [Update fee](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fees/update-fees.md): Updates a fee in the cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Fee ID from the [Create fee](/v3/cart-and-checkout/api-reference/carts-v3/fees/delete-fees) endpoint is used in the path parameter. - [Create fulfillment adjustment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fulfillment-adjustments/create-fulfillment-adjustments.md): Creates an adjustment to the fulfillment associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Fulfillment ID from the [Create fulfillment](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/create-fulfillments) endpoint is used in the path parameter. - [Delete fulfillment adjustment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fulfillment-adjustments/delete-fulfillment-adjustments.md): Removes the adjustment from the fulfillment associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Fulfillment ID from the [Create fulfillment](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/create-fulfillments) endpoint is used in the path parameter. The Adjustment ID from the [Create fulfillment adjustment](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment-adjustments/create-fulfillment-adjustments) endpoint is used in the path parameter. - [Update fulfillment adjustment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fulfillment-adjustments/update-fulfillment-adjustments.md): Updates the adjustment to the fulfillment associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Fulfillment ID from the [Create fulfillment](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/create-fulfillments) endpoint is used in the path parameter. The Adjustment ID from the [Create fulfillment adjustment](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment-adjustments/create-fulfillment-adjustments) endpoint is used in the path parameter. - [Create fulfillment fee](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fulfillment-fees/add-fulfillment.md): Creates a fee associated the fulfillment. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Fulfillment ID from the [Create fulfillment](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/create-fulfillments) endpoint is used in the path parameter. - [Delete fulfillment fee](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fulfillment-fees/delete-fulfillment.md): Removes the fee from associated with the fulfillment. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Fulfillment ID from the [Create fulfillment](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/create-fulfillments) endpoint is used in the path parameter. The Fee ID from the [Create fulfillment fee](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment-fees/add-fulfillment) endpoint is used in the path parameter. - [Update fulfillment fee](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fulfillment-fees/update-fulfillment.md): Updates the fee associated with the fulfillment. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Fee ID from the [Create fulfillment fee](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment-fees/add-fulfillment) endpoint is used in the path parameter. - [Add fulfillment attributes](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/add-fulfillments-attribute.md): Partially updates the attributes of the fulfillment associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Fulfillment ID from the [Create fulfillment](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/create-fulfillments) endpoint is used in the path parameter. - [Create fulfillment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/create-fulfillments.md): Creates a fulfillment to the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Delete fulfillment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/delete-fulfillments.md): Removes the fulfillment associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Fulfillment ID from the [Create fulfillment](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/create-fulfillments) endpoint is used in the path parameter. - [Delete fulfillment attributes](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/delete-fulfillments-attribute.md): Partially deletes attributes of your choice in the fulfillment object associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Fulfillment ID from the [Create fulfillment](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/create-fulfillments) endpoint is used in the path parameter. - [Get fulfillment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/retrieve-fulfillments.md): Returns the fulfillment associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Fulfillment ID from the [Create fulfillment](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/create-fulfillments) endpoint is used in the path parameter. - [Update fulfillment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/update-fulfillments.md): Updates the fulfillment associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Fulfillment ID from the [Create fulfillment](/v3/cart-and-checkout/api-reference/carts-v3/fulfillment/create-fulfillments) endpoint is used in the path parameter. - [Update item attributes](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/item-actions/add-item-attributes.md): Partially updates the attributes of your choice in the item object associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Item ID from the [Create item](/v3/cart-and-checkout/api-reference/carts-v3/items/items) endpoint is used in the path parameter. - [Delete item attributes](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/item-actions/delete-item-attributes.md): Partially deletes attributes of your choice in the item object associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Item ID from the [Create item](/v3/cart-and-checkout/api-reference/carts-v3/items/items) endpoint is used in the path parameter. - [Split line items](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/item-actions/split.md): Splits the item associated with the corresponding cart into multiple line items based on quantity. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Item ID from the [Create item](/v3/cart-and-checkout/api-reference/carts-v3/items/items) endpoint is used in the path parameter. - [Create item adjustment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/item-adjustments/create-item-adjustments.md): Creates an adjustment for the item in the cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Item ID from the [Create item](/v3/cart-and-checkout/api-reference/carts-v3/items/items) endpoint is used in the path parameter. - [Delete item adjustment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/item-adjustments/delete-item-adjustments.md): Deletes the adjustment from the item associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Item ID from the [Create item](/v3/cart-and-checkout/api-reference/carts-v3/items/items) endpoint is used in the path parameter. The Adjustment ID from the [Create item adjustment](/v3/cart-and-checkout/api-reference/carts-v3/item-adjustments/create-item-adjustments) endpoint is used in the path parameter. - [Update item adjustment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/item-adjustments/update-item-adjustments.md): Updates the adjustment to the item associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Item ID from the [Create item](/v3/cart-and-checkout/api-reference/carts-v3/items/items) endpoint is used in the path parameter. The Adjustment ID from the [Create item adjustment](/v3/cart-and-checkout/api-reference/carts-v3/item-adjustments/create-item-adjustments) endpoint is used in the path parameter. - [Create item fee](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/item-fees/create-item-fees.md): Creates a fee for the item. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Item ID from the [Create item](/v3/cart-and-checkout/api-reference/carts-v3/items/items) endpoint is used in the path parameter. - [Delete item fee](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/item-fees/delete-item-fees.md): Deletes the fee that is applied to the item. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Item ID from the [Create item](/v3/cart-and-checkout/api-reference/carts-v3/items/items) endpoint is used in the path parameter. The Fee ID from the [Create item fee](/v3/cart-and-checkout/api-reference/carts-v3/item-fees/create-item-fees) endpoint is used in the path parameter. - [Update item fee](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/item-fees/update-item-fees.md): Updates the fee that is applied to the item. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Item ID from the [Create item](/v3/cart-and-checkout/api-reference/carts-v3/items/items) endpoint is used in the path parameter. The Fee ID from the [Create item fee](/v3/cart-and-checkout/api-reference/carts-v3/item-fees/create-item-fees) endpoint is used in the path parameter. - [Delete item](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/items/delete-items.md): Deletes the item from the cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Item ID from the [Create item](/v3/cart-and-checkout/api-reference/carts-v3/items/items) endpoint is used in the path parameter. - [Get item](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/items/get-items.md): Returns the item from the cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Item ID from the [Create item](/v3/cart-and-checkout/api-reference/carts-v3/items/items) endpoint is used in the path parameter. - [Create item](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/items/items.md): Creates the item in the cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Update item](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/items/update-items.md): Updates the item in the cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Item ID from the [Create item](/v3/cart-and-checkout/api-reference/carts-v3/items/items) endpoint is used in the path parameter. - [Merge Cart Behaviors](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/merge-carts-behaviors.md) - [Apply coupon](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/orchestrator/carts/add-coupon.md): Apply a coupon code to the corresponding cart. The Cart ID from the [Create cart](/v3/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The coupon code generated when [creating a custom coupon](/v3/api-reference/carts-v3/carts-adjustments/create-adjustments) in Copilot is used in the path parameter. - [Delete cart](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/orchestrator/carts/delete-cart.md): Removes the cart corresponding to the provided cart ID. The Cart ID from the [Create cart](/v3/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Removes coupon](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/orchestrator/carts/delete-coupon.md): Removes the coupon from the corresponding cart. The Cart ID from the [Create cart](/v3/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Get the cart](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/orchestrator/carts/get-cart.md): Retrieves the cart information corresponding to the provided cart ID. The Cart ID from the [Create cart](/v3/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Create an order draft](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/orchestrator/carts/order-drafts.md): Creates an order from the current cart. The Cart ID from the [Create cart](/v3/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Add items](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/orchestrator/line-items/add-items.md): Add items to the corresponding cart. The Cart ID from the [Create cart](/v3/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Delete items](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/orchestrator/line-items/delete-items.md): Removes the items from the corresponding cart. The Cart ID from the [Create cart](/v3/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Split line items](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/orchestrator/line-items/split-items.md): Splits the item associated with the corresponding cart into multiple line items based on quantity. The Cart ID from the [Create cart](/v3/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The Item ID from the [Create item](/v3/api-reference/carts-v3/items/items) endpoint is used in the path parameter. - [Update items](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/orchestrator/line-items/update-items.md): Updates the item information in the corresponding cart. The Cart ID from the [Create cart](/v3/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Authorize payments](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/orchestrator/payments/authorize.md): Authorize payments made within the corresponding cart. The Cart ID from the [Create cart](/v3/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Void payments](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/orchestrator/payments/void.md): Void payments made within the corresponding cart. The Cart ID from the [Create cart](/v3/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Create an order draft](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/order-drafts/create-order-drafts.md): Create an order using the cart ID of the cart that contains the order. - [Get the order draft by the customer ID](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/order-drafts/get-order-drafts-customerid.md): Retrieves the order draft using the customer ID associated with it from [Create an order draft](/v3/cart-and-checkout/api-reference/carts-v3/order-drafts/create-order-drafts) endpoint. - [Get the order draft by the order draft ID](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/order-drafts/get-order-drafts-draftid.md): Retrieves the order draft using the order ID associated with it from [Create an order draft](/v3/cart-and-checkout/api-reference/carts-v3/order-drafts/create-order-drafts) endpoint. - [Get the order draft by the order draft number](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/order-drafts/get-order-drafts-number.md): Retrieves the order draft using the order number associated with it from [Create an order draft](/v3/cart-and-checkout/api-reference/carts-v3/order-drafts/create-order-drafts) endpoint. - [Overview](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/overview.md) - [Add payment attributes](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/payments/add-payment-attributes.md): Partially updates attributes of your choice in the payment. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The ID from the [Create payment](/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments) endpoint is used in the path parameter. - [Create payment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments.md): Adds a payment method to the corresponding cart to process a transaction. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Delete payment attributes](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/payments/delete-payment-attributes.md): Partially deletes attributes of your choice in the payment object associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The ID from the [Create payment](/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments) endpoint is used in the path parameter. - [Delete payment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/payments/delete-payments.md): Removes the payment from the cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The ID from the [Create payment](/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments) endpoint is used in the path parameter. - [Update payment](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/payments/update-payments.md): Updates the payment in the cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. The ID from the [Create payment](/v3/cart-and-checkout/api-reference/carts-v3/payments/create-payments) endpoint is used in the path parameter. - [Replace inventory data](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/validations/add-inventory-data.md): Replaces inventory data associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Replace product data](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/validations/add-product-data.md): Replaces product data associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Replace promotions](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/validations/add-promotions.md): Replaces promotions associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Replace tax data](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/validations/add-tax.md): Replaces tax data associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Updates inventory data](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/validations/updates-inventory-data.md): Partially updates inventory data associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [Updates product data](https://developer.fabric.inc/v3/cart-and-checkout/api-reference/carts-v3/validations/updates-product-data.md): Partially updates product data associated with the corresponding cart. The Cart ID from the [Create cart](/v3/cart-and-checkout/api-reference/carts-v3/carts/carts) endpoint is used in the path parameter. - [BigCommerce Integration](https://developer.fabric.inc/v3/dropship/dropship-retailers/bigcommerce-integration-1.md) - [Publishing Products to BigCommerce](https://developer.fabric.inc/v3/dropship/dropship-retailers/bigcommerce-publish-products.md) - [fabric Integration](https://developer.fabric.inc/v3/dropship/dropship-retailers/fabric-integration.md) - [Import Products & Attributes](https://developer.fabric.inc/v3/dropship/dropship-retailers/import-products---attributes.md) - [Submit and Manage Import Requests](https://developer.fabric.inc/v3/dropship/dropship-retailers/import-requests.md) - [Inventory](https://developer.fabric.inc/v3/dropship/dropship-retailers/inventory.md): View and export inventory reports on both the item and supplier levels. - [Inviting Suppliers](https://developer.fabric.inc/v3/dropship/dropship-retailers/inviting-suppliers.md) - [Invoices](https://developer.fabric.inc/v3/dropship/dropship-retailers/invoices.md): View, export, and manage invoices for all dropship orders. - [Loop Integration](https://developer.fabric.inc/v3/dropship/dropship-retailers/loop-integration.md) - [Create Purchase Order](https://developer.fabric.inc/v3/dropship/dropship-retailers/orders/create-purchase-order.md): Generate a custom purchase order manually. - [Managing cancels & backorders](https://developer.fabric.inc/v3/dropship/dropship-retailers/orders/managing-cancels---backorders.md): Manage orders canceled or flagged as backordered by a supplier. - [Order Detail](https://developer.fabric.inc/v3/dropship/dropship-retailers/orders/order-detail.md): Search for and view detailed information on each order. - [Orders](https://developer.fabric.inc/v3/dropship/dropship-retailers/orders/orders.md): Visualize the information needed to manage all aspects of your dropship orders across all connected suppliers. - [Returns and Credit Memos](https://developer.fabric.inc/v3/dropship/dropship-retailers/orders/returns-and-credit-memos.md): Create returns on orders and manage the credit memos associated with those returns. - [Shipping & Tracking](https://developer.fabric.inc/v3/dropship/dropship-retailers/orders/shipping---tracking.md) - [Overview](https://developer.fabric.inc/v3/dropship/dropship-retailers/overview.md): Rapidly launch, operate, and scale a curated assortment of products from an unlimited number of dropship suppliers. - [Proposals](https://developer.fabric.inc/v3/dropship/dropship-retailers/proposals.md): Review and approve proposals online. - [Compliance Scorecard](https://developer.fabric.inc/v3/dropship/dropship-retailers/reports/compliance-scorecard.md) - [Reports](https://developer.fabric.inc/v3/dropship/dropship-retailers/reports/reports.md) - [Sales Performance Reporting](https://developer.fabric.inc/v3/dropship/dropship-retailers/reports/sales-performance-reporting.md) - [Attribute Value Transformers](https://developer.fabric.inc/v3/dropship/dropship-retailers/settings/attribute-value-transformers.md): Transform the value of attributes automatically and accurately. - [Categories & Commission Profiles](https://developer.fabric.inc/v3/dropship/dropship-retailers/settings/categories---commission-profiles.md) - [Proposal Departments](https://developer.fabric.inc/v3/dropship/dropship-retailers/settings/proposal-departments.md): Standardize product data rules for all suppliers across various categories. - [Rulesets](https://developer.fabric.inc/v3/dropship/dropship-retailers/settings/rulesets.md): Set the conditions and validations used by the Proposal Department. - [Settings](https://developer.fabric.inc/v3/dropship/dropship-retailers/settings/settings.md): Add users and configure notifications in Dropship. - [Templates](https://developer.fabric.inc/v3/dropship/dropship-retailers/settings/templates.md): Keep data consistent between internal and external systems - [Shopify Integration](https://developer.fabric.inc/v3/dropship/dropship-retailers/shopify-integration.md): Integrate your fabric Dropship account with your Shopify account - [Publishing Products to Shopify](https://developer.fabric.inc/v3/dropship/dropship-retailers/shopify-publish-products.md) - [Supplier Information](https://developer.fabric.inc/v3/dropship/dropship-retailers/supplier-information.md) - [Supplier Payment](https://developer.fabric.inc/v3/dropship/dropship-retailers/supplier-payment.md): Track supplier invoices and payments - [Support](https://developer.fabric.inc/v3/dropship/dropship-retailers/support.md) - [BigCommerce Integration](https://developer.fabric.inc/v3/dropship/dropship-suppliers/bigcommerce-integration.md) - [Adding Fulfillment Locations](https://developer.fabric.inc/v3/dropship/dropship-suppliers/fulfillment/adding-fulfillment-locations.md) - [Bulk Actions for Orders](https://developer.fabric.inc/v3/dropship/dropship-suppliers/fulfillment/bulk-actions-for-orders.md) - [Fulfillment](https://developer.fabric.inc/v3/dropship/dropship-suppliers/fulfillment/fulfillment.md): Process and ship orders from all connected retail partners. - [Invoices](https://developer.fabric.inc/v3/dropship/dropship-suppliers/fulfillment/invoices.md): Invoice orders directly within Dropship individually or in bulk via file upload. - [Shipments & Tracking](https://developer.fabric.inc/v3/dropship/dropship-suppliers/fulfillment/shipments---tracking.md): Update orders with tracking information on a single order or in bulk via file upload and generate shipping labels. - [Inventory](https://developer.fabric.inc/v3/dropship/dropship-suppliers/inventory.md): Maintain inventory positions for your items in Dropship via file upload. - [Overview](https://developer.fabric.inc/v3/dropship/dropship-suppliers/overview.md): fabric Dropship provides suppliers a platform to discover, connect with, and grow successful partnerships with retailers to expand their reach and distribution - [Import Products from Shopify](https://developer.fabric.inc/v3/dropship/dropship-suppliers/product-management/import-products-from-shopify.md) - [Product Management](https://developer.fabric.inc/v3/dropship/dropship-suppliers/product-management/product-management.md): Upload all your product offerings and submit them to your connected retailer partners. - [Reporting](https://developer.fabric.inc/v3/dropship/dropship-suppliers/reporting.md) - [Retailer Information](https://developer.fabric.inc/v3/dropship/dropship-suppliers/retailer-information.md) - [Returns](https://developer.fabric.inc/v3/dropship/dropship-suppliers/returns.md): Approve and reject returns, then issue credit memos in Dropship. - [Settings](https://developer.fabric.inc/v3/dropship/dropship-suppliers/settings.md): Manage information about your business and its operations. - [ShipStation Integration](https://developer.fabric.inc/v3/dropship/dropship-suppliers/shipstation-integration.md) - [Shopify Integration](https://developer.fabric.inc/v3/dropship/dropship-suppliers/shopify-integration.md) - [Supplier Onboarding Guide](https://developer.fabric.inc/v3/dropship/dropship-suppliers/supplier-onboarding-guide.md) - [Support](https://developer.fabric.inc/v3/dropship/dropship-suppliers/support.md) - [WooCommerce Integration](https://developer.fabric.inc/v3/dropship/dropship-suppliers/woocommerce-integration.md) - [API Authentication](https://developer.fabric.inc/v3/getting-started/api-guides/api-authentication.md) - [API Overview](https://developer.fabric.inc/v3/getting-started/api-guides/api-overview.md) - [API References](https://developer.fabric.inc/v3/getting-started/api-guides/api-references.md) - [Example](https://developer.fabric.inc/v3/getting-started/api-guides/example.md) - [Getting Started with fabric APIs](https://developer.fabric.inc/v3/getting-started/api-guides/getting-started-with-fabric-apis.md) - [Identifiers](https://developer.fabric.inc/v3/getting-started/api-guides/identifiers.md) - [Making your first API request](https://developer.fabric.inc/v3/getting-started/api-guides/making-your-first-api-request.md) - [Security and Compliance](https://developer.fabric.inc/v3/getting-started/api-guides/security-and-compliance.md): Learn how we protect customer data, user data, and the reliability of our commerce services and applications. - [Using Developer Portal](https://developer.fabric.inc/v3/getting-started/api-guides/using-developer-portal.md) - [Authorize user apps with and without PKCE](https://developer.fabric.inc/v3/getting-started/authentication-v3/authentication-endpoints/authorize-user-app-with-and-without-pkce.md): 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) - [Fetch access token](https://developer.fabric.inc/v3/getting-started/authentication-v3/authentication-endpoints/fetch-access-token.md): 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. - [Authentication Endpoints](https://developer.fabric.inc/v3/getting-started/authentication-v3/authentication-endpoints/overview.md) - [Concepts](https://developer.fabric.inc/v3/getting-started/authentication-v3/concepts.md) - [Getting Started with System Apps](https://developer.fabric.inc/v3/getting-started/authentication-v3/system-apps/getting-started-with-system-apps.md) - [System App Authentication](https://developer.fabric.inc/v3/getting-started/authentication-v3/system-apps/system-app-authentication.md) - [Best Practices for Customizing Login Flows](https://developer.fabric.inc/v3/getting-started/authentication-v3/user-apps/best-practices-for-customizing-login-flows.md) - [Customizing Customer Login](https://developer.fabric.inc/v3/getting-started/authentication-v3/user-apps/customizing-customer-login.md) - [Getting Started with User Apps](https://developer.fabric.inc/v3/getting-started/authentication-v3/user-apps/getting-started-with-user-apps.md) - [Migrate Existing Users to a User App](https://developer.fabric.inc/v3/getting-started/authentication-v3/user-apps/migrate-existing-users-to-a-user-app.md) - [User App Authentication](https://developer.fabric.inc/v3/getting-started/authentication-v3/user-apps/user-app-authentication.md) - [Adding Team Members](https://developer.fabric.inc/v3/getting-started/copilot/adding-team-members.md) - [Copilot Overview](https://developer.fabric.inc/v3/getting-started/copilot/copilot-overview.md): Copilot is the web-based user interface to access the features in the fabric commerce platform. The suite of applications available via Copilot provide solutions to manage digital commerce needs directly, using online forms and prebuilt web components thereby reducing dependence on technical development resources and custom code. These applications can be used as individual components that can be launched quickly and easily, regardless of your existing infrastructure, capabilities, or third-party partnerships. - [Product Catalog AI](https://developer.fabric.inc/v3/getting-started/copilot/fabric-ai/catalog-ai.md) - [Fulfillment AI](https://developer.fabric.inc/v3/getting-started/copilot/fabric-ai/fulfillment-ai.md) - [Overview](https://developer.fabric.inc/v3/getting-started/copilot/fabric-ai/overview.md) - [Feature Descriptions](https://developer.fabric.inc/v3/getting-started/copilot/feature-descriptions.md) - [Glossary](https://developer.fabric.inc/v3/getting-started/copilot/glossary.md) - [Terms and Conventions](https://developer.fabric.inc/v3/getting-started/copilot/terms-and-conventions.md) - [Algolia connector](https://developer.fabric.inc/v3/integrations/algolia-connector.md) - [Avalara connector](https://developer.fabric.inc/v3/integrations/avalara-connector.md) - [Constructor.io connector](https://developer.fabric.inc/v3/integrations/constructor-io-connector.md) - [Overview](https://developer.fabric.inc/v3/integrations/overview.md) - [Stripe connector](https://developer.fabric.inc/v3/integrations/stripe-connector.md) - [Create add-on](https://developer.fabric.inc/v3/offers/api-reference/offers/add-ons/create-add-on.md): Create an add-on with its price and currency details. By creating add-ons, you can enhance customer experience by allowing them to choose personalized products while placing an order. - [Delete a specific add-on](https://developer.fabric.inc/v3/offers/api-reference/offers/add-ons/delete-a-specific-add-on.md): Delete an add-on by ID. - [Get a specific add-on](https://developer.fabric.inc/v3/offers/api-reference/offers/add-ons/get-a-specific-add-on.md): Get a specific add-on by ID. - [Get all add-ons](https://developer.fabric.inc/v3/offers/api-reference/offers/add-ons/get-all-add-ons.md): Get a paginated list of all the created add-ons. - [Add-ons](https://developer.fabric.inc/v3/offers/api-reference/offers/add-ons/overview.md) - [Update a specific add-on](https://developer.fabric.inc/v3/offers/api-reference/offers/add-ons/update-a-specific-add-on.md): Update a specific add-on by ID. - [Create attribute](https://developer.fabric.inc/v3/offers/api-reference/offers/attributes/create-attribute.md): Use this endpoint to create a new attribute. Attributes can be used as part of the qualifications for promotions or coupons. - [Delete attribute](https://developer.fabric.inc/v3/offers/api-reference/offers/attributes/delete-attribute.md): Using this endpoint, you can delete an attribute by its ID. - [Get all attributes](https://developer.fabric.inc/v3/offers/api-reference/offers/attributes/get-all-attributes.md): Using this endpoint, you can get a paginated list of attributes. You can narrow down the search results by specifying pagination criteria, and you can also sort the results. - [Get attribute](https://developer.fabric.inc/v3/offers/api-reference/offers/attributes/get-attribute.md): Using this endpoint, you can get details of an attribute by its ID. - [Update attribute](https://developer.fabric.inc/v3/offers/api-reference/offers/attributes/update-attribute.md): Using this endpoint, you can update an attribute by its ID. You can primarily update attribute and its value. - [Bulk update coupon codes](https://developer.fabric.inc/v3/offers/api-reference/offers/coupon-codes/bulk-update-coupon-codes.md): Use this endpoint to update multiple coupon codes using identifiers. Identifiers are a unique combination of a coupon code and a promotion ID. You can update up to 25 codes at a time. - [Get all coupon codes](https://developer.fabric.inc/v3/offers/api-reference/offers/coupon-codes/get-all-coupon-codes.md): This endpoint provides coupon code lists. Use parameters to filter results, for example, set `status` as 'ACTIVE' for active coupons, or add `userId` for user-specific coupon codes. Navigate the results using the query parameters `size` and `startCursor`. - [Create coupon](https://developer.fabric.inc/v3/offers/api-reference/offers/coupons/create-coupon.md): Create a coupon with the requested conditions. - [Delete a specific coupon](https://developer.fabric.inc/v3/offers/api-reference/offers/coupons/delete-a-specific-coupon.md): Delete a specific coupon by ID - [Enable or disable a coupon](https://developer.fabric.inc/v3/offers/api-reference/offers/coupons/enable-or-disable-a-coupon.md): Change coupon status by ID. **Enable a coupon:** Only *disabled* coupons can be enabled. **Disable a coupon:** Only *not expired* coupons can be disabled. - [Generate coupon codes](https://developer.fabric.inc/v3/offers/api-reference/offers/coupons/generate-coupon-codes.md): Generate coupon codes based on the given parameter. - [Get all coupons](https://developer.fabric.inc/v3/offers/api-reference/offers/coupons/get-all-coupons.md): Get a paginated list of coupons. - [Coupons](https://developer.fabric.inc/v3/offers/api-reference/offers/coupons/overview.md) - [Retrieve a coupon](https://developer.fabric.inc/v3/offers/api-reference/offers/coupons/retrieve-a-coupon.md): Use this endpoint to retrieve the details of a coupon by its ID. - [Search for coupons](https://developer.fabric.inc/v3/offers/api-reference/offers/coupons/search-for-coupons.md): Use this endpoint to search for coupons based on filter conditions. - [Update a specific coupon](https://developer.fabric.inc/v3/offers/api-reference/offers/coupons/update-a-specific-coupon.md): Update a specific coupon by ID. - [Exporting Offers CSV](https://developer.fabric.inc/v3/offers/api-reference/offers/developer-guide/exporting-csv.md) - [Download exported CSV file](https://developer.fabric.inc/v3/offers/api-reference/offers/exports/download-exported-csv-file.md): This endpoint lets you generate a URL, using fileId, from which you can download the exported CSV file. The generated URL expires in five mins. - [Get all export requests](https://developer.fabric.inc/v3/offers/api-reference/offers/exports/get-all-export-requests.md): Get a paginated list of all the export requests. - [Get export request by ID](https://developer.fabric.inc/v3/offers/api-reference/offers/exports/get-export-request-by-id.md): Get the details of a specific export request by the corresponding `exportId` that was generated from the [initiate export request](/v3/api-reference/offers/exports/initiate-export-request) endpoint. - [Initiate export request](https://developer.fabric.inc/v3/offers/api-reference/offers/exports/initiate-export-request.md): Initiate an export request based on the specified filter criteria. - [Generate URL to import a CSV file](https://developer.fabric.inc/v3/offers/api-reference/offers/imports/generate-url-to-import-a-csv-file.md): Use this endpoint to create a secured S3 URL to import a CSV file, allowing for bulk data updates from the information within the file. For example, if the data in the file is price type, then only the price related data will be updated. Note that an error will be shown if the type of data included in the file doesn't match with the data type mentioned in the request body. You must upload only one single file, specifically in the CSV format, to the generated URL. - [Get import job by ID](https://developer.fabric.inc/v3/offers/api-reference/offers/imports/get-import-job-by-id.md): Get details of a specific import job by job ID. - [Get import jobs](https://developer.fabric.inc/v3/offers/api-reference/offers/imports/get-import-jobs.md): Get a paginated list of import jobs. - [Retrieve the download URL for an error file](https://developer.fabric.inc/v3/offers/api-reference/offers/imports/retrieve-the-download-url-for-an-error-file.md): Use this endpoint to retrieve an AWS S3 URL to access the error data of a previously imported file. The URL is valid for five minutes. Make a GET request with this URL to download the error data in a CSV format. - [Offers (3.0.0)](https://developer.fabric.inc/v3/offers/api-reference/offers/offers--3-0-0.md) - [Create price control](https://developer.fabric.inc/v3/offers/api-reference/offers/price-controls/create-price-control.md): Create a price control record that contains various price types other than the elemental prices such as base price, sale price, and sale price. - [Delete price controls by itemId](https://developer.fabric.inc/v3/offers/api-reference/offers/price-controls/delete-price-controls-by-itemid.md): Delete price controls of a specific item by `itemId` - [Get all price controls](https://developer.fabric.inc/v3/offers/api-reference/offers/price-controls/get-all-price-controls.md): Get a paginated list of all the created price controls. - [Get price controls by itemId](https://developer.fabric.inc/v3/offers/api-reference/offers/price-controls/get-price-controls-by-itemid.md): Get price control records of an item by `itemId` and `priceListId`. If `priceListId` isn't specified, price controls of the item will be retrieved under the default price list. - [Get price controls by SKU](https://developer.fabric.inc/v3/offers/api-reference/offers/price-controls/get-price-controls-by-sku.md): Get price controls of a specific product by `sku`. - [Price Controls](https://developer.fabric.inc/v3/offers/api-reference/offers/price-controls/overview.md) - [Update price controls by itemId](https://developer.fabric.inc/v3/offers/api-reference/offers/price-controls/update-price-controls-by-itemid.md): Update price controls of a specific item by `itemId` and `piceListId`. If `priceListId` isn't specified, price controls of the item will be updated under the default price list. - [Create price list](https://developer.fabric.inc/v3/offers/api-reference/offers/price-lists/create-price-list.md): Create a price list. Based on the currency code you define for a price list, you will be able to create or update prices under the price list for the defined currency code only. - [Delete a specific price list](https://developer.fabric.inc/v3/offers/api-reference/offers/price-lists/delete-a-specific-price-list.md): Delete a specific price list by ID. - [Get a specific price list](https://developer.fabric.inc/v3/offers/api-reference/offers/price-lists/get-a-specific-price-list.md): Get a specific price list by ID. - [Get all price lists](https://developer.fabric.inc/v3/offers/api-reference/offers/price-lists/get-all-price-lists.md): Get a paginated list of all price lists. - [Price Lists](https://developer.fabric.inc/v3/offers/api-reference/offers/price-lists/overview.md) - [Update a specific price list](https://developer.fabric.inc/v3/offers/api-reference/offers/price-lists/update-a-specific-price-list.md): Update a specific price list by ID. - [Create price method](https://developer.fabric.inc/v3/offers/api-reference/offers/price-methods/create-price-method.md): Create a price method that you can use to set up the SKU price. Price method can be created based on SKU quantity, dimension of the SKU, or any other strategy that aligns with the business. - [Delete a specific price method](https://developer.fabric.inc/v3/offers/api-reference/offers/price-methods/delete-a-specific-price-method.md): Delete a specific price method by ID. - [Get all price methods](https://developer.fabric.inc/v3/offers/api-reference/offers/price-methods/get-all-price-methods.md): Get a paginated list of all price methods of SKUs. - [Price Methods](https://developer.fabric.inc/v3/offers/api-reference/offers/price-methods/overview.md) - [Update a specific price method](https://developer.fabric.inc/v3/offers/api-reference/offers/price-methods/update-a-specific-price-method.md): Update a specific price method by ID. - [Get price types](https://developer.fabric.inc/v3/offers/api-reference/offers/price-types/get-price-types.md): Get a paginated list of all price types. - [Price Types](https://developer.fabric.inc/v3/offers/api-reference/offers/price-types/overview.md) - [Get priced products](https://developer.fabric.inc/v3/offers/api-reference/offers/priced-products/get-priced-products.md): Get a paginated list of products and prices for the specified price list ID. - [Get product and price details by product item ID](https://developer.fabric.inc/v3/offers/api-reference/offers/priced-products/get-product-and-price-details-by-product-item-id.md): Get product and price details by product item ID - [Get product and price details by SKU](https://developer.fabric.inc/v3/offers/api-reference/offers/priced-products/get-product-and-price-details-by-sku.md): Retrieves the details of a product and its associated prices using the SKU, including the details for the variants of the product, if any. - [Get SKUs in price list](https://developer.fabric.inc/v3/offers/api-reference/offers/priced-products/get-skus-in-price-list.md): Retrieve SKUs and product item IDs that have a price entry in the given price list. - [Create batch prices](https://developer.fabric.inc/v3/offers/api-reference/offers/prices/create-batch-prices.md): Create one or more prices for items based on `itemId` and `itemSku`. - [Create price](https://developer.fabric.inc/v3/offers/api-reference/offers/prices/create-price.md): Create or update price of an item based on given `itemId` and `itemSku` - [Delete price by itemId](https://developer.fabric.inc/v3/offers/api-reference/offers/prices/delete-price-by-itemid.md): Delete price details by `itemId`. If `priceListId` isn't specified, price is deleted for the `itemId` that belongs to the default price list. - [Delete price by SKU](https://developer.fabric.inc/v3/offers/api-reference/offers/prices/delete-price-by-sku.md): Delete price record for the given `sku` and `priceListId`. - [Get all active prices](https://developer.fabric.inc/v3/offers/api-reference/offers/prices/get-all-active-prices.md): Get a paginated list of active and scheduled prices. Active prices have start date greater than the current date and end date is in the future. - [Get price by itemId](https://developer.fabric.inc/v3/offers/api-reference/offers/prices/get-price-by-itemid.md): Get a paginated list of price details for the given `itemId` and `priceListId`. If `priceListId` isn't specified, prices are retrieved for the `itemId` that belongs to the default price list. - [Get price by SKU](https://developer.fabric.inc/v3/offers/api-reference/offers/prices/get-price-by-sku.md): Get price details for the `sku` and `priceListId`. If `priceListId` isn't specified, price is retrieved for the `sku` that belongs to the default price list. - [Prices](https://developer.fabric.inc/v3/offers/api-reference/offers/prices/overview.md) - [Create product exclusion list](https://developer.fabric.inc/v3/offers/api-reference/offers/product-exclusion-lists/create-product-exclusion-list.md): Create a product exclusion list with target products that will be exempted from being discounted. - [Delete a specific product exclusion list](https://developer.fabric.inc/v3/offers/api-reference/offers/product-exclusion-lists/delete-a-specific-product-exclusion-list.md): Delete a specific product exclusion list by ID. - [End a product exclusion list](https://developer.fabric.inc/v3/offers/api-reference/offers/product-exclusion-lists/end-a-product-exclusion-list.md): End a product exclusion list by setting the start date and end date to the same current date. When you end a product exclusion list, target products of the product exclusion list become eligible for discounts. - [Get a specific product exclusion list](https://developer.fabric.inc/v3/offers/api-reference/offers/product-exclusion-lists/get-a-specific-product-exclusion-list.md): Get a specific product exclusion list by ID. The response contains a list of target products that are exempted from being discounted based on the `scopes` value. - [Get all product exclusion lists](https://developer.fabric.inc/v3/offers/api-reference/offers/product-exclusion-lists/get-all-product-exclusion-lists.md): Get a paginated list of product exclusion lists based on the query parameters. - [Product Exclusion Lists](https://developer.fabric.inc/v3/offers/api-reference/offers/product-exclusion-lists/overview.md) - [Update a specific product exclusion list](https://developer.fabric.inc/v3/offers/api-reference/offers/product-exclusion-lists/update-a-specific-product-exclusion-list.md): Update a specific product exclusion list record by ID. - [Create promotion](https://developer.fabric.inc/v3/offers/api-reference/offers/promotions/create-promotion.md): Create a promotion to apply to one or more items to increase sales, or to a customer segment to reward existing customers or attract new ones. Promotions are configured with rules that define the promotion type, conditions, and discounts. - [Delete a specific promotion](https://developer.fabric.inc/v3/offers/api-reference/offers/promotions/delete-a-specific-promotion.md): Delete a specific promotion using the corresponding `promotionId`. - [Enable or disable a promotion](https://developer.fabric.inc/v3/offers/api-reference/offers/promotions/enable-or-disable-a-promotion.md): Use this endpoint to change the status of a promotion by enabling or disabling it. You can't change the status of a promotion that's currently in the `ACTIVE` state. You can enable promotions that are disabled or disable promotions that haven't yet expired. - [End a promotion](https://developer.fabric.inc/v3/offers/api-reference/offers/promotions/end-a-promotion.md): End a specific promotion using the corresponding `promotionId`. To end a promotion, set the `status` to `EXPIRED` and set both the `startAt` and `endAt` dates to the current date. - [Get a specific promotion](https://developer.fabric.inc/v3/offers/api-reference/offers/promotions/get-a-specific-promotion.md): Retrieves a specific promotion using the corresponding `promotionId`. - [Get all promotions](https://developer.fabric.inc/v3/offers/api-reference/offers/promotions/get-all-promotions.md): Retrieves a paginated list of all promotions. - [Promotions](https://developer.fabric.inc/v3/offers/api-reference/offers/promotions/overview.md) - [Search for promotions](https://developer.fabric.inc/v3/offers/api-reference/offers/promotions/search-for-promotions.md): Use this endpoint to search for promotions based on specified filter conditions. - [Update a specific promotion](https://developer.fabric.inc/v3/offers/api-reference/offers/promotions/update-a-specific-promotion.md): Updates a specific promotion using the corresponding `promotionId`. - [Calculate prices for products by IDs](https://developer.fabric.inc/v3/offers/api-reference/offers/real-time-pricing-engine/calculate-prices-for-products-by-ids.md): Use this endpoint to calculate prices for one or more products in a specific price list using item IDs. If you prefer to use SKUs to calculate product prices, use the [calculate prices for products by SKUs](/v3/api-reference/offers/real-time-pricing-engine/calculate-prices-for-products-by-skus) endpoint. - [Calculate prices for products by SKUs](https://developer.fabric.inc/v3/offers/api-reference/offers/real-time-pricing-engine/calculate-prices-for-products-by-skus.md): Use this endpoint to calculate prices for one or more products in a specific price list by product SKUs. If you prefer to use item IDs to calculate product prices, use the [calculate prices for products by item IDs](/v3/api-reference/offers/real-time-pricing-engine/calculate-prices-for-products-by-item-ids) endpoint. `itemId` is used as the default identifier for a product. If you want to set SKUs as product identifiers and use this endpoint, you must contact fabric support at support@fabric.inc. - [Evaluate cart promotions](https://developer.fabric.inc/v3/offers/api-reference/offers/real-time-pricing-engine/evaluate-cart-promotions.md): Evaluate cart's total cost instantly, after applying all applicable promotions and discount coupons. Using this endpoint, submit a range of data that will be referenced against the conditions that are set earlier using the promotions, coupons or prices APIs. The response includes the details of the promotions and discounts applied. These promotions and discounts can be displayed on your website to help shoppers know that they're getting their expected discounts. - [Real-time Pricing Engine](https://developer.fabric.inc/v3/offers/api-reference/offers/real-time-pricing-engine/overview.md) - [Bulk update redemptions](https://developer.fabric.inc/v3/offers/api-reference/offers/redemptions/bulk-update-redemptions.md): Use this endpoint to update multiple redemptions by including the corresponding `redemptionId` values in the request body. You can update up to 25 redemptions at a time. - [Create redemption](https://developer.fabric.inc/v3/offers/api-reference/offers/redemptions/create-redemption.md): Creates a redemption for a specific promotion using the corresponding `promotionId` value in the request body. - [Create redemption](https://developer.fabric.inc/v3/offers/api-reference/offers/redemptions/create-redemption-using-coupon.md): Creates a redemption for a specific coupon using the corresponding `couponId` value. - [Delete a coupon redemption by ID](https://developer.fabric.inc/v3/offers/api-reference/offers/redemptions/delete-coupon-redemption-by-id.md): Delete a specific redemption by redemption ID. - [Delete redemption by ID](https://developer.fabric.inc/v3/offers/api-reference/offers/redemptions/delete-redemption-by-id.md): Deletes a specific redemption using the corresponding `redemptionId` value. - [Get all redemption details](https://developer.fabric.inc/v3/offers/api-reference/offers/redemptions/get-all-redemption-details.md): Use this endpoint to retrieve a list of redemption records. You can filter the records using parameters, such as `couponCode`, `userId`, `email`, `orderId`, or `storeId`. - [Get redemption by ID](https://developer.fabric.inc/v3/offers/api-reference/offers/redemptions/get-redemption-by-id.md): Retrieves a specific redemption using the corresponding `redemptionId` value. - [Redemptions](https://developer.fabric.inc/v3/offers/api-reference/offers/redemptions/overview.md) - [Update redemption by ID](https://developer.fabric.inc/v3/offers/api-reference/offers/redemptions/update-redemption-by-id.md): Updates a specific redemption using the corresponding `redemptionId`. - [Create segment](https://developer.fabric.inc/v3/offers/api-reference/offers/segments/create-segment.md): Create a segment to group a specific set of customers. By segmenting customers, you can gain insight into which products are popular among different customer segments, and can create targeted retention strategies. You can also create targeted marketing campaigns that can result in higher conversion rates and increased sales. - [Delete a specific segment](https://developer.fabric.inc/v3/offers/api-reference/offers/segments/delete-a-specific-segment.md): Delete a specific segment by ID. - [Get a specific segment](https://developer.fabric.inc/v3/offers/api-reference/offers/segments/get-a-specific-segment.md): Get details of a specific segment by ID. - [Get all segments](https://developer.fabric.inc/v3/offers/api-reference/offers/segments/get-all-segments.md): Get a paginated list of all the created segments. - [Segments](https://developer.fabric.inc/v3/offers/api-reference/offers/segments/overview.md) - [Update a specific segment](https://developer.fabric.inc/v3/offers/api-reference/offers/segments/update-a-specific-segment.md): Update a specific segment by ID. - [Coupon](https://developer.fabric.inc/v3/offers/api-reference/offers/webhook-events/coupon.md) - [Global Exclusion](https://developer.fabric.inc/v3/offers/api-reference/offers/webhook-events/global-exclusion.md) - [Glossary](https://developer.fabric.inc/v3/offers/api-reference/offers/webhook-events/glossary.md): This section collects brief definitions of some of the technical terms used in the documentation for Convoy. - [Price](https://developer.fabric.inc/v3/offers/api-reference/offers/webhook-events/price.md) - [Price List](https://developer.fabric.inc/v3/offers/api-reference/offers/webhook-events/price-list.md) - [Promotion](https://developer.fabric.inc/v3/offers/api-reference/offers/webhook-events/promotion.md) - [Redemption](https://developer.fabric.inc/v3/offers/api-reference/offers/webhook-events/redemption.md) - [Ship To](https://developer.fabric.inc/v3/offers/api-reference/offers/webhook-events/ship-to.md) - [Subscribing Events](https://developer.fabric.inc/v3/offers/api-reference/offers/webhook-events/subscribing-events.md) - [Webhook Events](https://developer.fabric.inc/v3/offers/api-reference/offers/webhook-events/webhook-events.md) - [Creating a Buy Get Coupon](https://developer.fabric.inc/v3/offers/user-guides/offers/coupons/creating-a-buy-get-coupon.md) - [Creating a SKU Quantity Coupon](https://developer.fabric.inc/v3/offers/user-guides/offers/coupons/creating-a-sku-quantity-coupon.md) - [Managing Coupons](https://developer.fabric.inc/v3/offers/user-guides/offers/coupons/managing-coupons.md) - [Overview](https://developer.fabric.inc/v3/offers/user-guides/offers/coupons/overview.md) - [Overview](https://developer.fabric.inc/v3/offers/user-guides/offers/overview.md): Offers is fabric's pricing and promotions engine with tools to manage your pricing, promotions, and coupons in one place. - [Adding Bulk Price](https://developer.fabric.inc/v3/offers/user-guides/offers/pricing/add-bulk-price.md) - [Managing Prices](https://developer.fabric.inc/v3/offers/user-guides/offers/pricing/managing-prices.md) - [Overview](https://developer.fabric.inc/v3/offers/user-guides/offers/pricing/pricing-overview.md) - [null](https://developer.fabric.inc/v3/offers/user-guides/offers/promotions/creating-a-buy-get-promotion.md) - [null](https://developer.fabric.inc/v3/offers/user-guides/offers/promotions/creating-a-sku-promotion.md) - [null](https://developer.fabric.inc/v3/offers/user-guides/offers/promotions/creating-a-sku-quantity-promotion.md) - [Managing Promotions](https://developer.fabric.inc/v3/offers/user-guides/offers/promotions/managing-promotions.md) - [Overview](https://developer.fabric.inc/v3/offers/user-guides/offers/promotions/overview.md) - [Settings](https://developer.fabric.inc/v3/offers/user-guides/offers/settings.md) - [Managing Price Lists](https://developer.fabric.inc/v3/offers/user-guides/offers/settings/price-lists.md) - [Create counter](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/counters/create-counter.md): Create counter (also known as inventory position) for better tracking of inventories. - [Get all counters](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/counters/get-all-counters.md): Get all configured counters. - [Get counter by code](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/counters/get-counter-by-code.md): Get details of a specific counter by specified counter code. - [Getting Started with Counters](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/counters/overview.md) - [Update counter by code](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/counters/update-counter-by-code.md): Update a specific counter based on specified counter code. - [Create an inventory import file configuration](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/imports/create-import-configs.md): Create inventory import file configuration containing rules for queried file prefix - [Delete inventory import file config](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/imports/delete-an-import-config-by-id.md): Delete inventory import file config containing rules for queried file prefix - [Force import halt](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/imports/force-trigger.md): Force import halted due to zeroed out Inventories more than threshold - [Get uploaded file status and details](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/imports/get-file-status-by-id.md): Get uploaded file status and details by specifying `importId`. - [Get inventory import upload file configuration](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/imports/get-import-config-by-id.md): Get inventory import file configurations containing rules for queried file prefix - [Get all file configurations](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/imports/get-import-configuration.md): Get all file configurations for matching filter criteria - [Get uploaded files that match specified criteria](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/imports/get-uploaded-files.md): Get uploaded files that match specified criteria. Returned as paginated records. - [Import inventory data](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/imports/import-inventory.md): Import inventory data 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. - [Update inventory import file configuration](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/imports/update-import-config-by-id.md): Update inventory import file configuration - [Inventory (3.0.0)](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/inventory--3-0-0.md) - [Inventory FAQ](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/inventory-faq-s.md) - [Adjust inventory counters](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/inventory/adjust-inventory-counters.md): With this endpoint, you can modify inventory counters (also known as inventory positions) to maintain accurate inventory records. These counters are adjusted when new inventory is received or when an item is shipped. If the inventory does not exist, an error message will be displayed. An inventory can have multiple counters, and all counters will be updated when this endpoint is used. - [Create inventory](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/inventory/create-inventory.md): Create inventory based on the combination of location number, channel ID, and item ID or SKU. - [Find inventories of specific items](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/inventory/find-inventories-of-specific-items.md): Search for inventories of specific items by SKUs, itemIds, location numbers, and other parameters as specified in the request body. This endpoint retrieves the exact available quantity of the searched inventory. - [Find inventory of specific items in a specific region](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/inventory/find-inventory-of-specific-items-in-a-specific-region.md): Search for list of inventories of specific items in a specific region based on SKUs, postal code, latitude, longitude, and other details of the location as specified in the request body. - [Getting Started with Inventory](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/inventory/overview.md) - [Search for inventories](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/inventory/search-for-inventories.md): Search for inventories based on filter criteria. - [Update inventory by adding new property](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/inventory/update-inventory-by-adding-new-property.md): Add a new property to existing inventory.

**Note:** This endpoint does not override all the existing properties; rather it updates inventory by adding new properties or by updating the existing inventory properties that are specified in the request body. Inventory is identified based on the combination of location number, channel ID, and item ID or SKU.

- [Cancel an outage using outageNumber](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/locations/cancel-outage-by-outage-number.md): Using the location outages cancel endpoint you can cancel a location outage by providing the `outageNumber`. - [Cancel an outage using outageID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/locations/cancel-outage-by-outageid.md): The location outages cancel endpoint is used to cancel an outage by providing the `outageId`. - [Create a location](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/locations/create-a-location.md): Create a location to use for managing inventory and orders. - [Create Outage](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/locations/create-location-outage.md): The location outages endpoint is used to create a location outage. - [Delete a location](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/locations/delete-a-location.md): Delete a location by location number. - [Get LocationOutages by query](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/locations/find-location-outage.md): Get a filtered list of LocationOutages. - [Get a specific location](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/locations/get-a-specific-location.md): Get a specific location by location number. - [Get locations by query](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/locations/get-locations-by-query.md): Get a list of locations by specified filter criteria. - [Getting Started with Locations](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/locations/overview.md) - [Search for nearby locations](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/locations/search-for-nearby-locations.md): Search for nearby locations based on city name, state, postal code, and other geographical details as mentioned in the request body. - [Update a specific location](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/locations/update-a-specific-location.md): Update details of a specific location by location number. - [Update an outage by outageNumber](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/locations/update-outage-by-outage-number.md): You can use the location outages outage number endpoint to update the details of a specific location outage by providing its outageNumber. - [Update an outage using outageID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/locations/update-outage-by-outageid.md): Update the details of a specified location outage by providing the `outageId`. - [Create inventory network](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/create-inventory-network.md): Create a network using conditional rules to add locations and SKU to the network. - [Delete network by code](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/delete-network-by-code.md): Delete a specific network, with all its details, by specified network code. Once deleted, it can't be undone. - [Get all networks](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/get-all-networks.md): Get a paginated list of all the created networks. - [Get network by code](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/get-network-by-code.md): Get details of a specific network by code. - [Search for inventory hard reservations](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/search-hard-reserve.md): Search for hard reservations based on filter criteria. - [Release soft reservation](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/soft-release.md): Release soft reservation. - [Soft reservation](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve.md): Soft reserve quantity. - [Update network by code](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/update-network-by-code.md): Update details of a specific inventory network by specified network code. - [Get allocation by ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/allocations/get-allocation-by-id.md): Get allocation details by allocation ID. The allocation ID can be obtained using the `/allocations/search` endpoint or stored externally, for example, in the WMS order database. - [Getting Started with Allocations](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/allocations/overview.md) - [Search for allocations by query](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/allocations/search-for-allocations-by-query.md): Search for inventory allocations based on the matching filter criteria. - [Update allocation or initiate reallocation](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/allocations/update-allocation-or-initiate-reallocation.md): Update allocation or initiate reallocation of the order by `allocationRequestId`. - [Update allocation attributes](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/allocations/update-attributes.md): Update allocation attributes by `allocationId`. - [Create appeasement by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/appeasements/create-appeasement-by-order-id.md): When customer is dissatisfied with their shopping experience, you may want to offer an appeasements amount such as partial refund to keep them happy.

This endpoint is used to create appeasement request by order ID

. **Note**: If you do not have an order ID, but have an order number, use the order number-based endpoint - `POST /orders/order-number/{orderNumber}/actions/create-appeasement`.

- [Create appeasement by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/appeasements/create-appeasement-by-order-number.md): When customer is dissatisfied with their shopping experience, you may want to offer an appeasement amount to keep them happy.

This endpoint is used to create appeasement request by order number.

**Note**: If you don't have order number, use the corresponding order ID-based endpoint - `POST /orders/{orderId}/actions/create-appeasement`

- [Getting Started with Appeasements](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/appeasements/overview.md) - [Get backorder or preorder details by ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/backorders-preorders/get-backorder-or-preorder-details-by-id.md): Get backorder or preorder reservation details by ID. - [Getting Started with Backorders & Preorders](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/backorders-preorders/overview.md) - [Record customer agreement to delay shipment](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/backorders-preorders/record-customer-agreement-to-delay-shipment.md): Record customer's agreement to delay the shipment. - [Search for backorders or preorders by query](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/backorders-preorders/search-for-backorders-or-preorders-by-query.md): Search for the backorder or preorder reservations based on filter criteria. - [Cancel order by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/cancellations/cancel-order-by-order-id.md): When customer's order cancellation request is determined to be eligible, this endpoint processes the cancellation by order ID.

**Note**: If you do not have the order number, use the corresponding order number-based endpoint - `POST /orders/order-number/{orderNumber}/actions/cancel`.

- [Cancel order by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/cancellations/cancel-order-by-order-number.md): When customer's order cancellation request is determined to be eligible, this endpoint processes the cancellation by order number.

**Note**: If you do not have order number, use the corresponding order ID-based endpoint - `POST /orders/{orderId}/actions/cancel`.

- [Get order cancellation eligibility by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/cancellations/get-order-cancellation-eligibility-by-order-id.md): Either customer may initiate cancellation due to an incorrect order placement or as a merchant, you may initiate cancellation due to product unavailability, pricing errors, payment failure, or shipping restrictions. Before processing cancellation, it's crucial to determine the eligibility of the cancellation request.

This endpoint gets the eligibility of order cancellation by order ID. You can additionally specify `lineItemIds` to get the eligibility of specific line items.

**Note**: If you do not have order ID, use the corresponding order number-based endpoint -`POST /orders/order-number/{orderNumber}/actions/check-exchange-eligibility`.

- [Get order cancellation eligibility by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/cancellations/get-order-cancellation-eligibility-by-order-number.md): Either customer may initiate cancellation due to an incorrect order placement or as a merchant, you may initiate cancellation due to product unavailability, pricing errors, payment failure, or shipping restrictions. Before processing cancellation, it's crucial to determine the eligibility of the cancellation request.

This endpoint gets the eligibility of the cancellation request by order number. You can additionally specify `lineItemIds` to get the eligibility of specific line items.

**Note**: If you do not have order number, use the corresponding order ID-based endpoint - `/orders/{orderId}/actions/check-cancel-eligibility`.

- [Getting Started with Cancellations](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/cancellations/overview.md) - [Check credits eligibility by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/credits/check-credits-eligibility-by-order-id.md): In case of refund scenarios, credits such as 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 ID, allowing businesses to manage credits effectively and provide appropriate compensation to eligible customers.

- [Create credits by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/credits/create-credits-by-order-id.md): Use this endpoint to create credits by order ID. - [Create credits by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/credits/create-credits-by-order-number.md): The following endpoint is used to create credits using an order number. - [Update credit status by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/credits/update-credit-status-by-order-number.md): The update credit status endpoint is used to update the credits status, notes, and additional credit attributes. - [Update credits by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/credits/update-credits-by-order-id.md): Use this endpoint to update the credit status, as well as to add any associated notes and additional attributes. - [Inventory Setup](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/inventory-setup.md) - [List of Webhook Events](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/list-of-webhook-events.md) - [Importing order and inventory data](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/order-and-inventory-import.md) - [Order Exchange](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/order-exchange.md) - [Order Fulfillment](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/order-fulfillment.md) - [Order Return](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/order-return.md) - [Overview](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/developer-guide/overview.md) - [Export data by query](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/exports/export-data-by-query.md): Initiate data export by the given filter criteria. - [Get export job by exportId](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/exports/get-export-job-by-exportid.md): Get details of a specific export job by specified `exportId`. - [Get export jobs by query](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/exports/get-export-jobs-by-query.md): Get a paginated list of all the export jobs based on the filter criteria specified in the request body. - [Get file headers by module](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/exports/get-file-headers-by-module.md): Get the list of file headers for a given module.

**Note:** File headers are basically the column headers or titles of the exported document.

- [Getting Started with Exports](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/exports/overview.md) - [Cancel fraud order by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/frauds/cancel-fraud-order-by-order-id.md): 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 number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/frauds/cancel-fraud-order-by-order-number.md): 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`.

- [Getting Started with Frauds](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/frauds/overview.md) - [Release fraud order](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/frauds/release-fraud-order.md): 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 by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/frauds/release-fraud-order-by-order-id.md): 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`.

- [Get uploaded file status and details](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/imports/get-uploaded-file-status-and-details.md): Get uploaded file status and details by specifying `importId`. - [Get uploaded files that match specified criteria](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/imports/get-uploaded-files-that-match-specified-criteria.md): Get uploaded files that match specified criteria. Returned as paginated records. - [Getting Started with Imports](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/imports/overview.md) - [Upload bulk file to import data](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/imports/upload-bulk-file-to-import-data.md): 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. - [null](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/inventory-transfer/cancel-inventory-transfer.md) - [null](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/inventory-transfer/create-inventory-transfer.md) - [null](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/inventory-transfer/get-inventory-transfer-by-transfershipmentid.md) - [null](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/inventory-transfer/inventory-transfer-query.md) - [null](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/inventory-transfer/inventory-transfer-search.md) - [null](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/inventory-transfer/package-tracking-acknowledge.md) - [null](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/inventory-transfer/packing-and-unpacking.md) - [null](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/inventory-transfer/receive-inventory-tracking.md) - [null](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/inventory-transfer/update-tracking-for-an-inventory-transfer.md) - [Acknowledge financial transaction](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/invoices/acknowledge-financial-transaction.md): When an order is created or processed, fabric generates invoice and sends it to merchants or third-party systems for further financial processing of the order. This endpoint lets merchants acknowledge that they have received the invoice with payment information. - [Get invoice by ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/invoices/get-invoice-by-id.md): Get details of an invoice by invoice ID. - [Getting Started with Invoices](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/invoices/overview.md) - [Search for invoices](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/invoices/search-for-invoices.md): Search for invoices by matching filter criteria. - [Get acknowledgment receipt for notification](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/notifications/get-acknowledgment-receipt-for-notification.md): This endpoint gets notification acknowledgment from external service. - [Getting Started with Notifications](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/notifications/overview.md) - [Resend notifications](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/notifications/resend-notifications.md): 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. - [Orders (3.0.0)](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders--3-0-0.md) - [Orders FAQ](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders-faq-s.md) - [Check appeasement eligibility by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders/check-appeasement-eligibility.md): This endpoint checks for the appeasement eligibility of an order by order number. - [Check appeasement eligibility by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders/check-appeasement-eligibility-by-id.md): This endpoint checks for the appeasement eligibility of an order by orderId. - [Check credits eligibility by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders/check-credit-eligibility.md): 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.

- [Get order exchange eligibility by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders/check-exchange-eligibility.md): 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`.

- [Create new order](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders/create-new-order.md): 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. - [Find orders](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders/find-orders.md): 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.

- [Get order by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders/get-order-by-order-id.md): 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 number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders/get-order-by-order-number.md): 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}`.

- [Getting Started with Orders](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders/overview.md) - [Update Shipping information for an existing order by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders/update-attributes.md): The following endpoint is used to update attributes by order number. - [Update Order Attributes](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders/update-attributes-by-id.md): 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 customer details for given order IDs](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders/update-customer-details-for-given-order-ids.md): 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.

- [Updates order pick-up details](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/orders/updates-order-pick-up-details.md): 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.

- [Authorize order payments](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/payments/authorize-payments.md): This endpoint is used synchronously or asynchronously for authorizing order payments pending for authorization. - [Getting Started with Order Payments](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/payments/overview.md) - [Update order payment status by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/payments/update-order-payment-status-by-order-id.md): This endpoint is used sync order payments when transactions happen externally. Additionally, used for updating order payment status and the amount, whether it is captured, refunded or void amount.

If you don't have order ID, use the corresponding order number-based endpoint - POST /orders/order-number/{orderNumber}/actions/update-payment-status.

- [Update status of order payment by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/payments/update-status-of-order-payment-by-order-number.md): This endpoint is used sync order payments when transactions happen externally. Additionally, used for updating order payment status and the amount, whether it is captured, refunded or void amount.

If you don't have order number, use the corresponding order ID-based endpoint - POST /orders/{orderId}/actions/update-payment-status.

- [Get eligibility of returns for items in an order by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/returns/get-eligibility-of-returns-for-items-in-an-order-by-order-id.md): Customers may want to return one or more items because they do not meet the expectations or customer has changed their mind. Before processing return, it's crucial to verify whether the items are eligible for return as per your policy

This endpoint gets the eligibility of your return by order number. You can additionally specify `lineItemId` to get the eligibility of a single line item.

**Note**: If you do not have the order ID, use the corresponding order number-based endpoint - `POST /orders/order-number/{orderNumber}/actions/check-return-eligibility`.

- [Get order exchange eligibility by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/returns/get-order-exchange-eligibility-by-order-id.md): Customers may want exchange an item because of size, 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 eligibility of exchange request by order number. You can additionally specify `lineItemId` to get eligibility of a specific item.

**Note**: If you do not have the order ID, but have the order number, use the order number-based endpoint - `POST /orders/order-number/{orderNumber}/actions/check-exchange-eligibility`.

- [Get order exchange eligibility by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/returns/get-order-exchange-eligibility-by-order-number.md): 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 return eligibility by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/returns/get-return-eligibility-by-order-number.md): Customers may want to return one or more items because they do not meet the expectations or customer has changed their mind. Before processing return, it's crucial to verify whether the items are eligible for return as per your policy

This endpoint gets the eligibility of return by order number. You can additionally specify `lineItemId` to get the eligibility of a single line item.

**Note**: If you do not have the order number, use the corresponding order ID-based endpoint - `POST /orders/{orderId}/actions/check-return-eligibility`.

- [Order return by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/returns/order-return-by-order-id.md): When customer's return request is found to be eligible, this endpoint submits the return request by order ID.

**Note**: If you do not have order ID, use the corresponding order number-based endpoint- `POST /orders/order-number/{orderNumber}/actions/submit-return-request`.

- [Order return by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/returns/order-return-by-order-number.md): When the customer's return request is determined to be eligible, this endpoint is used to process the return request.

**Note**: If you do not have the order number, but have order ID, use Return order by order ID endpoint - `POST /orders/{orderId}/actions/submit-return-request`.

- [Getting Started with Returns](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/returns/overview.md) - [Acknowledge shipment](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipments/acknowledge-shipment.md): For users of fabric Webhook Service, Shipment related events can trigger HTTP callbacks to notify web clients through a merchant-defined URL/URI, typically an API Gateway for a middleware. While the response to fabric Webhook service HTTP call-back may occur, a secondary call-back can use this Acknowledge Shipment endpoint to indicate that a secondary external system has acknowledged this shipment event. Middleware receives the event, transforms it in a suitable format, and sends a success response back to fabric, confirming it received the event. It also sends the transformed event to an external merchant system (typically in XML or JSON).

With this endpoint, middleware immediately sends an asynchronous acknowledgement to fabric, based on shipping ID, to indicate whether the call was successful. This acknowledgement is used for learning, auditing, and taking any necessary action.

- [Create new shipment](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipments/create-new-shipment.md): To use this endpoint an “allocation” must exist for the order that's being shipped. When an order is placed, fabric sends allocation details to external merchant system to create order fulfillment requirement details in an external system. With reference to the allocation that's being shipped, users of this POST API can create shipment details for allocations.

**Note**: Shipment ID generated as part of the response is required for subsequent calls such as Acknowledge shipment (`POST /shipments/{shipmentId}/acknowledge`) and Get shipment (`GET /shipments/{shipmentId}`).

- [Create re-shipment](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipments/create-re-shipment.md): Orders may go missing before they're delivered to customers for reasons such as incorrect address, theft, labelling issues, or other reasons. This endpoint triggers reshipment in such cases for the existing location.

**Note**: Shipment ID generated as part of the response is required for subsequent calls such as Acknowledge shipment (POST /shipments/{shipmentId}/acknowledge) and Get shipment (GET /shipments/{shipmentId}).

- [Find shipments](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipments/find-shipments.md): As merchants, you may want to view shipments of specific statuses, monitor progress of deliveries, and proactively manage situations to ensure timely deliveries.

This endpoint enables you to easily search for shipments based on the specified criteria in the request body. You can refine your search by specifying `limit` and `offset`. When they're not specified, by default you will get up to 10 records. In addition, you can `sort` results.

- [Get shipment by ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipments/get-shipment-by-id.md): As merchants, you may want to resolve customer queries related to shipment or track a specific shipment to manage customer expectations with timely communication.

This endpoint gets details of a single shipment by ID. You will get `shipmentId` by using the search endpoint, or by referencing a `shipmentId` on a file such as the Invoice.

- [Getting Started with Shipments](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipments/overview.md) - [Update gift card activation status](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipments/update-gift-card-activation-status.md): This endpoint is used to activate gift cards before they're delivered to the customer. Typically used by “adapters” or external web services integrated with gift card applications, so that gift cards can be activated as part of the fabric fulfillment workflow. - [Update shipment tracking](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipments/update-shipment-tracking.md): The update tracking endpoint creates a new tracking log that can be used to update the order status. The most common application of this endpoint is to connect to external web services or 'adapters' that have been integrated with carrier tracking applications. With this endpoint, fabric Shipment service gets information from carrier tracking applications, and in turn, updates customers about their shipment status. - [Add items to shipping method](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipping-method-items/add-items-to-shipping-method.md): 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.

- [Delete items from shipping method](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipping-method-items/delete-items-from-shipping-method.md): 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.

- [Get item IDs for given shipping method](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipping-method-items/get-item-ids-for-given-shipping-method.md): 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 shipping methods](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipping-method-items/get-shipping-methods.md): 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.

- [Create shipping method](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipping-methods/create-shipping-method.md): 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.

- [Delete shipping method](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipping-methods/delete-shipping-method.md): 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.

- [Find shipping methods](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipping-methods/find-shipping-methods.md): 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.

- [Get shipping method](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipping-methods/get-shipping-method.md): 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.

- [Update shipping method](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shipping-methods/update-shipping-method.md): 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.

- [Add or update items in a shopping list](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shopping-list-items/add-or-update-items-in-a-shopping-list.md): 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.

- [Delete items from shopping list](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shopping-list-items/delete-items-from-shopping-list.md): 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.

- [Get shopping list and its items](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shopping-list-items/get-shopping-list-and-its-items.md): By specifying list ID, you can get shopping list details along with its items. - [Get shopping list items by list ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shopping-list-items/get-shopping-list-items-by-list-id.md): 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 lists of a user along with associated items](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shopping-list-items/get-shopping-lists-of-a-user-along-with-associated-items.md): 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.

- [Create shopping list](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shopping-lists/create-shopping-list.md): 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`.

- [Delete a shopping list by ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shopping-lists/delete-a-shopping-list-by-id.md): Shoppers need to remove unwanted or irrelevant shopping lists. With this endpoint, they can delete a list by list ID. - [Get a shopping list by ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shopping-lists/get-a-shopping-list-by-id.md): Get details of a shopping list by ID, along with the number of items in it. - [Get shopping lists of a user](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shopping-lists/get-shopping-lists-of-a-user.md): 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`.

- [Getting Started with Lists](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shopping-lists/overview.md) - [Update a shopping list by ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/shopping-lists/update-a-shopping-list-by-id.md): 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.

- [Get acknowledgement for package tracking by order number](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/tracking/get-acknowledgement-for-package-tracking-by-order-number.md): This endpoint gets acknowledgement of package tracking by order number.

**Note**: If you do not have order number, use the corresponding order ID-based endpoint - `PUT /orders/{orderId}/actions/package-tracking-acknowledge`.

- [Get package tracking acknowledgement by order ID](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/tracking/get-package-tracking-acknowledgement-by-order-id.md): This endpoint gets acknowledgement of package tracking by order ID.

**Note**: If you do not have order ID, use the corresponding order number-based endpoint - `PUT /orders/order-number/{orderNumber}/actions/package-tracking-acknowledge`.

- [Getting Started with Tracking](https://developer.fabric.inc/v3/orders-and-inventory/api-reference/orders/tracking/overview.md) - [Create a Network](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/inventory/create-a-network.md) - [Creating a Location](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/inventory/create-location.md): Locations are used to fulfill orders - [Exporting Locations](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/inventory/export-locations.md) - [Importing Locations](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/inventory/import-locations.md) - [Inventory](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/inventory/manage-inventory-overview.md): See the stock of goods across locations all in one spot - [Overview](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/inventory/overview.md) - [Configuring Scheduled Closures](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/inventory/scheduledclosures.md) - [Activity Log](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/activity-log.md) - [Creating a Rule Set](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-fulfillment-logic/create-a-new-rule-set-ui.md) - [Updating a Rule Set](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-fulfillment-logic/manage-rule-sets.md) - [Order Fulfillment Logic Overview](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-fulfillment-logic/order-fulfillment-logic.md) - [Adding Products to an Existing Order](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/adding-products-to-existing-order.md) - [Creating Appeasement Refunds](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/appeasements.md) - [Canceling Items in an Order](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/cancel-skus.md) - [Creating an Order](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/creating-an-order.md) - [Processing Exchanges](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/exchange-orders.md) - [Exporting Orders](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/exporting-orders.md) - [Filtering Orders](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/filtering-orders.md) - [Overview](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/overview.md) - [Processing returns](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/returning-orders.md) - [Updating a Shipping Address](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/updating-shipping-address.md) - [Viewing Allocations](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/viewing-allocations.md) - [Viewing Allocation Details](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/viewing-details-of-an-order/allocation-details.md) - [Viewing Order Basic Details](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/viewing-details-of-an-order/basic-details.md) - [Viewing Invoice Details](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/viewing-details-of-an-order/invoice-details.md) - [Viewing Shipment Details](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/viewing-details-of-an-order/shipment-details.md) - [Viewing an Orders Activity Log](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/viewing-details-of-an-order/viewing-activity-log.md) - [Viewing Invoices](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/viewing-invoices.md) - [Viewing Orders](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/viewing-orders.md) - [Viewing Shipments](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/order-management/viewing-shipments.md) - [Overview](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/overview.md): Build a centralized source of order, inventory, and warehouse information with fabric Orders. - [Backorder & Preorder Settings](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/settings/backorder-preorder.md) - [Order Alerts](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/settings/order-alerts.md) - [Order Attributes](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/settings/order-attributes.md) - [Overview](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/settings/overview.md): Use the Order Settings menu to manage order attributes, shipping methods, policies, alerts, backorders, and preorders. - [Order Policies](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/settings/policies.md) - [Shipping Methods](https://developer.fabric.inc/v3/orders-and-inventory/user-guides/orders/settings/shipping-methods.md) - [Add a new address](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-address/add-a-new-address.md): Using this endpoint, you can add a new address for the customer by `customerId`. - [Delete customer's address](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-address/delete-customers-address.md): Using this endpoint, you can delete an existing address of a customer based on the `customerId` and `addressId`. - [Get customer's address](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-address/get-customers-address.md): Using this endpoint, you can get a single address of a customer based on the `customerId` and `addressId`. - [Get customer's addresses](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-address/get-customers-addresses.md): Using this endpoint, you can get all addresses of a customer.
By specifying the query parameters `offset` and `limit`, you can narrow down the search results. You can also `sort` the results in an ascending or descending order. Additionally, with the `isDeleted` query parameter, you can filter for either deleted or non-deleted customers. When no query parameter is specified, by default, you get up to 10 records. - [Customer Address](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-address/overview.md) - [Partially update customer's address](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-address/partially-update-customers-address.md): Using this endpoint, you can partially update a customer's address based on the `customerId` and `addressId`. To fully replace an existing address, use the `PUT /customers/{customerId}/customer-address/{addressId}` endpoint. - [Search for customer's addresses](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-address/search-for-customers-addresses.md): With this endpoint, you can search for customer's addresses based on the specified filter conditions. In addition, you can tailor the search results by including or excluding the deleted addresses and the default addresses.
**Note**:A customer can have a default address for both billing and shipping. - [Update customer's address](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-address/update-customers-address.md): Using this endpoint, you can update a customer's address based on the `customerId` and `addressId`. This replaces the existing address with the new one. If you want to make only a partial update, use the `PATCH /customers/{customerId}/customer-address/{addressId}` endpoint. - [Add a new customer](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-profile/add-a-new-customer.md): Using this endpoint, you can add a new customer to the system. The response includes an `id` which is required in subsequent calls, such as `GET /customers/{customerId}`, `PUT /customers/{customerId}`, `PATCH /customers/{customerId}`, and more.
When `externalId` is specified, the customers have the ability to manage their own details through the storefront UI. - [Delete customer](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-profile/delete-customer.md): With this endpoint, you can delete an existing customer data by `customerId`. - [Get customer details](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-profile/get-customer-details.md): Using this endpoint, you can get details of a single customer by `customerId`. - [Get customers](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-profile/get-customers.md): Use this endpoint to get a paginated list of customers.
By specifying the query parameters `offset` and `limit`, you can narrow down the search results. You can also `sort` the results in an ascending or descending order. Additionally, with the `isDeleted` query parameter, you can filter for either deleted or non-deleted customers. When no query parameter is specified, by default, you get up to 10 records. - [Partially update customer details](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-profile/partially-update-customer-details.md): Using this endpoint, you can partially update details of a customer by `customerId`. To fully replace the details of an existing customer, use the `PUT /customers/{customerId}` endpoint. - [Search for customer](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-profile/search-for-customer.md): Using this endpoint, you can search for customers based on filter conditions. By specifying `offset` and `limit`, you can narrow down your search results. In addition, using the `isDelete` property in the request body, you can filter for either deleted or non-deleted customers. - [Update customer details](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-profile/update-customer-details.md): Using this endpoint, you can update details of an existing customer by `customerId`.
This endpoint replaces the existing details of the customer. If you want to make only a partial update, without replacing the entire details, use the `PATCH /customers/{customerId}` endpoint. - [Update customer status](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-profile/update-customer-status.md): With this endpoint, you can update the account status of an existing customer by `customerId`. - [Add address - customer context.](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-self/add-address--customer-context.md): Using this endpoint, a customer can add their address through a storefront UI. - [Delete address - customer context](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-self/delete-address--customer-context.md): Using this endpoint, a customer can delete their own address through the storefront UI based on `addressId`. - [Get customer details - customer context](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-self/get-customer-details--customer-context.md): Using this endpoint, a customer can view their details through the storefront UI. - [Customer Self](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-self/overview.md) - [Update address - customer context](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-self/update-address--customer-context.md): Using this endpoint, a customer can update their own address through the storefront UI based on `addressId`. - [Update customer details - customer context](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-self/update-customer-details--customer-context.md): Using this endpoint, customers can update their own details through the storefront UI. - [View address - customer context](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-self/view-address--customer-context.md): Using this endpoint, a customer can view their own address through the storefront UI based on the `addressId`. - [View addresses - customer context](https://developer.fabric.inc/v3/platform/api-reference/customers/customer-self/view-addresses--customer-context.md): Using this endpoint, a customer can view their own addresses through the storefront UI. - [Overview](https://developer.fabric.inc/v3/platform/home/alerts/alerts-overview.md) - [Alerts Page](https://developer.fabric.inc/v3/platform/home/alerts/alerts-page.md) - [Creating Alerts](https://developer.fabric.inc/v3/platform/home/alerts/creating-alerts.md) - [Managing Alerts](https://developer.fabric.inc/v3/platform/home/alerts/managing-alerts.md) - [Sales Dashboard](https://developer.fabric.inc/v3/platform/sales-analytics/dashboard.md) - [Account Details](https://developer.fabric.inc/v3/platform/settings/account-details/account-details.md) - [Getting the Account ID](https://developer.fabric.inc/v3/platform/settings/account-details/getting-the-account-id.md) - [Requesting a New Account](https://developer.fabric.inc/v3/platform/settings/account-details/requesting-a-new-account.md) - [API Apps](https://developer.fabric.inc/v3/platform/settings/api-apps/api-apps.md) - [Creating a System App](https://developer.fabric.inc/v3/platform/settings/api-apps/creating-system-app.md) - [Creating a User App](https://developer.fabric.inc/v3/platform/settings/api-apps/creating-user-app.md) - [Getting System App Credentials](https://developer.fabric.inc/v3/platform/settings/api-apps/getting-system-app-credentials.md) - [Managing API Apps](https://developer.fabric.inc/v3/platform/settings/api-apps/managing-api-apps.md) - [Currencies](https://developer.fabric.inc/v3/platform/settings/internationalization/currencies.md) - [Internationalization](https://developer.fabric.inc/v3/platform/settings/internationalization/internationalization.md) - [Languages](https://developer.fabric.inc/v3/platform/settings/internationalization/languages.md) - [Role-Based Access Control (RBAC)](https://developer.fabric.inc/v3/platform/settings/rbac/role-based-access-control.md) - [Customers Roles](https://developer.fabric.inc/v3/platform/settings/rbac/role-based-access-control-customers-roles.md) - [Offers Roles](https://developer.fabric.inc/v3/platform/settings/rbac/role-based-access-control-offers-roles.md) - [Orders and Inventory Roles](https://developer.fabric.inc/v3/platform/settings/rbac/role-based-access-control-orders-roles.md) - [Product Catalog Roles](https://developer.fabric.inc/v3/platform/settings/rbac/role-based-access-control-products-roles.md) - [Inviting Users](https://developer.fabric.inc/v3/platform/settings/user-management/inviting-users.md) - [Managing Users](https://developer.fabric.inc/v3/platform/settings/user-management/managing-users.md) - [User Management](https://developer.fabric.inc/v3/platform/settings/user-management/user-management.md) - [Adding a Webhook](https://developer.fabric.inc/v3/platform/settings/webhooks/adding-a-webhook.md) - [Deleting a Webhook](https://developer.fabric.inc/v3/platform/settings/webhooks/deleting-a-webhook.md) - [Editing a Webhook](https://developer.fabric.inc/v3/platform/settings/webhooks/editing-a-webhook.md) - [List of Inventory Events](https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-inventory-events.md) - [List of Offers Events](https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-offers-events.md) - [List of Orders Events](https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-orders-events.md) - [List of Product Catalog Events](https://developer.fabric.inc/v3/platform/settings/webhooks/list-of-products-events.md) - [Managing Events and Logs](https://developer.fabric.inc/v3/platform/settings/webhooks/managing-events-and-logs.md) - [Webhooks](https://developer.fabric.inc/v3/platform/settings/webhooks/overview.md) - [Testing a Webhook](https://developer.fabric.inc/v3/platform/settings/webhooks/testing-a-webhook.md) - [Create a file object and retrieve the file upload URL](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/files/create-file.md): Use this endpoint to retrieve the URL of the AWS S3 location to upload the file that you want to import to the Catalog Connector. - [Download a file by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/files/download-file.md): Use this endpoint to retrieve the URL used to download a previously processed file. You can then make a GET request with this URL to retrieve the products data in CSV or JSONL format. The download link is valid for five minutes. - [Retrieve import and export history](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/files/get-file.md): Use this endpoint to access files previously imported to or exported from the Catalog Connector, sorted in chronological order. You can refine the search results by using the following query parameters: - `ids`: Provide a comma-separated list of file IDs to retrieve multiple files by their IDs. Note that pagination isn't supported when using this parameter. - Format type (`formatType`) : Specify the format of the file to filter files by format. The options are **CSV** or **JSONL**. - Operation type (`type`): Use this parameter to specify whether you want imported or exported files. - Pagination (`offset`, `limit`): Use offset and limit parameters to refine the number of results returned. - `sort`: Use this parameter to view results in ascending or descending order. If no query parameters are specified, the endpoint returns up to 10 records. - [Retrieve an import template](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/files/retrieve-import-template.md): Use this endpoint to retrieve the product import template for Catalog Connector in either CSV or JSONL format, based on your preferred data handling method. You can open CSV template in applications, such as Excel or Google Sheets and JSONL template in text editors compatible with JSONL, such as Visual Studio Code. After filling in product data, save the template file with a unique name on your local system. - [Export products](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/jobs/export.md): Use this endpoint to start an internal job to export products from Catalog Connector. Specify the `formatType` query parameter to export data in either CSV or JSONL format. In the request body, provide the `ids` of all products to be exported, the product type, and the locale. - [Retrieve jobs](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/jobs/retrieve-jobs.md): Use this endpoint to retrieve a paginated list of import and export jobs related to Catalog Connector. The following constraints apply when using the query parameters: - The query parameter job `ids` can't be combined with any other query parameters. - The query parameter `inputFileIds` can only be combined with the query parameter `lastJobOnly`. - Pagination isn't supported when `ids` or `inputFileIds` is specified. - [Delete a product by Item ID](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/item-operations/delete-by-item.md): Use this endpoint to delete a single product by its `itemId`. If you don't have the `itemId`, use one of the endpoints to delete the product: - [Delete a product by SKU](/v3/api-reference/catalog-connector/operations/sku-operations/delete-with-sku). - [Delete a product by product ID](/v3/api-reference/catalog-connector/operations/product-operations/delete-by-product). - [Retrieve a product or a variant by Item ID](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/item-operations/retrieve-by-item.md): Use this endpoint to retrieve a single product by its `itemId`. You must specify the query parameters `itemId` and `locale`. Optionally, you can set the following query parameters to `true` to refine the search results: You must specify the query parameters `itemId` and `locale`. Optionally, you can set the following query parameters to `true` to refine the search results: - `excludeBundleProducts`: Exclude bundled products from the response. - `excludeCollections`: Exclude collections from the response. - `excludeCategories`: Exclude categories from the response. - `excludeAttributes`: Exclude attributes from the response. - `excludeVariants`: Exclude variants from the response. If you don't have the `itemId`, use one of the endpoints to retrieve the product: - [Update a product by SKU](/v3/api-reference/catalog-connector/operations/sku-operations/update-with-sku). - [Update a product by product ID](/v3/api-reference/catalog-connector/operations/product-operations/update-by-product). - [Update a product by the Item ID.](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/item-operations/update-by-item.md): Use this endpoint to update a single product by using its `itemId`. You can update the product's details, such as its name, category details, product images, attributes, and collections. However, you can't update the `itemId`. The new data completely replaces the existing data. You can update the product's details, such as its name, category details, product images, attributes, and collections. However, you can't update the itemId. The new data completely replaces the existing data. If you don't have the `itemId`, use the one of the endpoints to delete the product: - [Update a product by SKU](/v3/api-reference/catalog-connector/operations/sku-operations/update-with-sku). - [Update a product by product ID](/v3/api-reference/catalog-connector/operations/product-operations/update-by-product). - [Add a product](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/product-operations/add-product.md): Use this endpoint to add a single product to Catalog Connector. You must specify the `locale` in the query parameter and the product data in the request body. Only `sku` is mandatory for product data. Optionally, you can specify the `type` as item, variant, or bundle. The default setting for `type` is item. - [Delete a product by product ID](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/product-operations/delete-by-product.md): Use this endpoint to delete a single product by its `productId`. If you don't have the `productId`, use one of the endpoints to delete the product: - [Delete a product by SKU](/v3/api-reference/catalog-connector/operations/sku-operations/delete-with-sku). - [Delete a product by item ID](/v3/api-reference/catalog-connector/operations/item-operations/delete-by-item). - [Retrieve a product by product ID](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/product-operations/retrieve-by-product.md): Use this endpoint to retrieve a single product by its `productId`. You must specify the query parameters `productId` and `locale`. Optionally, you can set the following query parameters to `true` to refine the search results: - `excludeBundleProducts`: Exclude bundled products from the response. - `excludeCollections`: Exclude collections from the response. - `excludeCategories`: Exclude categories from the response. - `excludeAttributes`: Exclude attributes from the response. - `excludeVariants`: Exclude variants from the response. If you don't have the `productId`, use one of the endpoints to retrieve the product: - [Retrieve a product by SKU](/v3/api-reference/catalog-connector/operations/sku-operations/update-with-sku). - [Retrieve a product by item ID](/v3/api-reference/catalog-connector/operations/item-operations/update-by-item). - [Update a product by product ID](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/product-operations/update-by-product.md): Use this endpoint to update a single product by its `productId`. You can update the product's details, such as its name, category details, product images, attributes, and collections. However, you can't update the productId. The new data completely replaces the existing data. If you don't have the `productId`, use one of the corresponding endpoints: - [Update a product by SKU](/v3/api-reference/catalog-connector/operations/product-operations/update-by-product). - [Update a product by item ID](/v3/api-reference/catalog-connector/operations/item-operations/update-by-item). - [Find products](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/search.md): Use this endpoint to search for products based on names, IDs, SKUs, image URLs, and more. By specifying the appropriate query parameters, you can exclude one or more types of data, such as collections, categories, variants, attributes, and products within a bundle. - Use the `CONTAINS` search operation to search for products based on keywords of SKU, name, and more. - Use the `IN` search operation to search for products based on one or more values, such as IDs, names, SKUs, image URLs, attributes, and types. - Use the less than or equals to, `LTE`, greater than or equals to, `GTE`, less than, `LT`, greater than, `GT` and equals `EQ` operations to search for date-specific values, such as time of creation or modification. - [Delete a product by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/sku-operations/delete-with-sku.md): Use this endpoint to delete a single product by using its SKU. If you don't have the product SKU, use one of the endpoints to delete the product: - [Delete a product by product ID](/v3/api-reference/catalog-connector/operations/product-operations/delete-by-product). - [Delete a product by item ID](/v3/api-reference/catalog-connector/operations/item-operations/delete-by-item). - [Retrieve a product by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/sku-operations/retrieve-with-sku.md): Use this endpoint to retrieve a single product by its SKU. You must specify the query parameters `sku` and `locale` to corresponding to the product. Optionally, you can set the following query parameters to `true` to refine the search results: - `excludeBundleProducts`: Exclude bundled products from the response. - `excludeCollections`: Exclude collections from the response. - `excludeCategories`: Exclude categories from the response. - `excludeAttributes`: Exclude attributes from the response. - `excludeVariants`: Exclude variants from the response. If you don't have the product SKU, use one of the endpoints to retrieve the product: - [Retrieve a product by product ID](/v3/api-reference/catalog-connector/operations/product-operations/retrieve-by-product). - [Retrieve a product by item ID](/v3/api-reference/catalog-connector/operations/item-operations/retrieve-by-item). - [Update a product by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/sku-operations/update-with-sku.md): Use this endpoint to update details of a product by its SKU. You can update details of the product, such as the product name, category details, product images, attributes, and collections. The new data replaces the existing data. Note that you can't update the SKU. If you don't have the product SKU, use one of the endpoints update the product details: - [Update a product by product ID](/v3/api-reference/catalog-connector/operations/product-operations/update-by-product). - [Update a product by item ID](/v3/api-reference/catalog-connector/operations/item-operations/update-by-item). - [Catalog Connector Overview](https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/overview.md) - [Create product attribute group](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attribute-groups/create-product-attribute-group.md): Attribute group is a collection of attributes that can be assigned to products or categories. This endpoint creates an attribute group with associated attributes so that it's easier to assign attributes to products and categories **Note**: At least one attribute must be specified. - [Delete attribute group](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attribute-groups/delete-attribute-group.md): To ensure product details are up to date, it's important to remove unused, incorrect attribute groups. This endpoint deletes an attribute group by its ID. - [Find attribute groups](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attribute-groups/find-attribute-groups.md): Attribute groups are a collection of attributes that can be assigned to products or categories. This endpoint searches for attribute groups based on the search criteria specified in the request body. - [Get all product attribute groups](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attribute-groups/get-all-product-attribute-groups.md): Attribute group is a collection of attributes that can be assigned to products or categories. This endpoint gets all the existing attribute groups along with their attributes. - [Get single attribute group](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attribute-groups/get-single-attribute-group.md): Attribute groups are a collection of attributes that can be assigned to products or categories. This endpoint gets details of the product attribute groups for the specified ID for proper details of product information on your e-commerce portal. - [Attribute Groups](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attribute-groups/overview.md) - [Update attribute group](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attribute-groups/update-attribute-group.md): When launching a new product line, it may be necessary to update certain aspects, such as adding or deleting attributes, updating attribute group name, or adjusting the sequence in which they appear on UI. This endpoint is used to group attributes and mark them as editable or read-only. In addition, you can update the details of attribute groups such as name, description, priority order, and more. This endpoint completely replaces the existing details. - [Get attributes mapping](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attributes-mapping/get-attributes-mapping.md): Before adding an item (with or without variants) to fabric **Product Catalog**, you must map merchant-specific attributes to fabric-specific attributes.
Once mapping is created, this endpoint is used to get the mapping details. - [Attributes Mapping](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attributes-mapping/overview.md) - [Update attributes mapping](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attributes-mapping/update-attributes-mapping.md): This endpoint updates mapping of merchant-defined attributes to fabric-defined standard attributes. This will help ensure consistency. - [Create attribute](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attributes/create-attribute.md): In fabric **Product Catalog**, both products (Items, Variants, and Bundles) and categories have attributes. For products, they may be technical specifications like size, weight, etc., design specifications like color, material, etc. For Categories, they may be basic specifications such as name, description, ID, etc. This endpoint creates attributes that can be assigned to a `target` - Product or Category. - [Delete single attribute](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attributes/delete-single-attribute.md): Over time, fabric **Product Catalog** may accumulate attributes that are no longer relevant or were created with incorrect or incomplete information. This can cause downstream issues. This endpoint provides the flexibility to delete an attribute by its ID, without impacting other attributes **Note**: An attribute can't be deleted if it's already assigned to `Item` or `Category`. - [Find attributes](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attributes/find-attributes.md): With this endpoint, you can search for attributes based on criteria such as name, creation or modification date, attribute type, and other factors. - [Get attributes](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attributes/get-attributes.md): Once attributes are created, this endpoint gets all the available attributes that can be assigned to the requested `target` - `item` or `category`. You can refine search results by specifying `offset` and `limit`. When they're not specified, by default, you'll get up to 10 attributes. - [Get single attribute](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attributes/get-single-attribute.md): E-commerce platforms (web or app) show product details based on attributes such as name, size, color, and other specifications. This endpoint gets the details of a particular attribute by its ID, which is used to display on the e-commerce platform. - [Attributes](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attributes/overview.md) - [Update single attribute](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/attributes/update-single-attribute.md): This endpoint updates attribute details such as name, description, validation criteria, and more, for the specified ID. The target and type fields cannot be updated via this endpoint. - [Create multiple categories](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/bulk-action-for-categories-and-collections/create-multiple-categories.md): Items are organized within categories, which form the original hierarchical tree structure with multiple levels of nested categories. This endpoint is used to add new categories within this structure. **Note**: 1. Upon onboarding a new merchant to fabric **Product Catalog**, a root category is automatically generated.
2. This endpoint doesn't support adding of parent and its children categories at the same time.
3. You can add up to 25 categories. - [Create multiple collections](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/bulk-action-for-categories-and-collections/create-multiple-collections.md): Collection is an alternative way to organize products compared to the original Category system; they're created based on merchant's requirements. This endpoint is used to create a new collection **Note**: You can create up to 25 collections in a single call. - [Update collections up to 25](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/bulk-action-for-categories-and-collections/update-collections-up-to-25.md): With this endpoint, you can update up to 25 collections. You can also update collection details, such as add sub-collections, exclude sub-collections, add validation rules for attributes, or reorder collections. **Note**:
1. This endpoint replaces the existing details.
2. To avoid losing all details, for minor updates, use the `partially update collection` endpoint - `PATCH /collections/{id}` - [Update multiple categories](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/bulk-action-for-categories-and-collections/update-multiple-categories.md): With this endpoint, you can update up to 25 categories and add new child categories. You can update the name of the category as required, update the parent category, change category attributes for improved product discovery, and modify product attributes to efficient product filtering. - [Create category](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/categories/create-category.md): Items are organized within categories, which form the original hierarchical tree structure with multiple levels of nested categories. This endpoint is used to create a new category within this structure. **Note**: 1. Upon onboarding a new merchant to fabric **Product Catalog**, a root category is automatically generated.
2. This endpoint doesn't support adding of children categories. Use the Update category endpoint - `PUT /categories/{id}` endpoint to add child categories. - [Delete category](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/categories/delete-category.md): If there is a change in product offerings , one or more categories may become unnecessary. This endpoint is used to delete a category by its ID. - [Find categories](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/categories/find-categories.md): This endpoint is used to search and find specific categories based on the search criteria given in the request body. This endpoint is also used to find the root category that's automatically created when the merchant is onboarded to fabric **Product Catalog**. - [Get a single category](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/categories/get-a-single-category.md): The Category system is the original tree hierarchy used to organize and categorize products. This endpoint gets the details of a specific category by its ID. The response includes basic info (ID, name, localized name (if applicable), list of category attributes, product attributes, associated product IDs, associated child categories, and more. - [Get attribute groups of a category](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/categories/get-attribute-groups-of-a-category.md): Attribute groups are a collection of attributes that can be assigned to an item or a category. For example, an `Electronics` category may have `Dimensions` as one of the attribute groups, with `length`, `width`, and `height` as individual attributes. This endpoint gets all attribute groups for the given category. For each attribute group, you can view its basic details such as ID, name, and priority as well as attribute details including validation rules, localized versions, and more - [Get navigation path for categories](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/categories/get-navigation-path-for-categories.md): In **Product Catalog**, items are organized in a hierarchy tree structure of parent and children categories. This endpoint gets the navigation path starting from the root (level 0) until the given category IDs. - [Get products by category](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/categories/get-products-by-category.md): To ensure correct items are grouped together within a category, it's important to review them in the context of each category. This endpoint gets a paginated list of products. For each product, you can view its attribute details, localized properties, variant IDs as well as the `categoryId`. You can refine your search results by specifying `offset`, and `limit`. When they're no specified, you'll get up to 10 results. - [Categories](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/categories/overview.md) - [Partially update category](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/categories/partially-update-category.md): In contrast to the Update Category endpoint - `PUT /categories/{id}`, which fully overwrites the category details, this endpoint allows for selective modification of specific details, such as fixing any typos present in category names as well as facilitating addition or removal of category attributes or product attributes. - [Update category](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/categories/update-category.md): Child categories can't be added while creating a new category (using the `POST /categories` endpoint). This endpoint is used to add a child category to a parent category. In addition, when there are changes in product offerings, this endpoint is used to change the item and category attributes as well as rename the category. This endpoint completely replaces the existing details. - [Copy Category to Collections](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/collections/copy-category-to-collections.md): This endpoint is used to replicate category tree hierarchy to collections. - [Create collection](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/collections/create-collection.md): Collection is an alternative way to organize products compared to the Category system, which is the original organization of items. Because the Category system isn't granular enough to meet all the requirements of Storefronts, collections are used to organize products as per the merchant's requirements. This endpoint is used to create a new collection within the alternative organization so that it can be adapted to support various use-cases of Storefronts. - [Delete collection](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/collections/delete-collection.md): If there is a change in product offerings, one or more collections may become unnecessary. This endpoint is used to delete a collection by ID. - [Find collections](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/collections/find-collections.md): This endpoint enables you to find collections by the search criteria you specify in the request body. You can also `sort` the results. - [Get a single collection](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/collections/get-a-single-collection.md): Collections are used to organize and categorize products on your e-commerce platform (website and app), making it easier for shoppers to browse and find products. This endpoint gets category details such as basic info (ID, name, localized name, status, etc.), attributes details, categories included, categories excluded, associated child categories, and more. - [Get navigation path for collections](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/collections/get-navigation-path-for-collections.md): On the Storefront, products are organized in hierarchical tree structure of parent and children collections. This endpoint gets the navigation path starting from the root (level 0) until the given collections. - [Get products under collection](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/collections/get-products-under-collection.md): To ensure the right set of products are organized within a collection, it's important to review products in each collection. This endpoint gets a paginated list of products in a collection. **Note**: You can refine your search by specifying `offset` and `limit`. When they're not specified, you'll get up to 10 products by default. - [Collections](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/collections/overview.md) - [Partially update collection](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/collections/partially-update-collection.md): In contrast to the Update Collection endpoint - `PUT /collections/{id}`, which fully overwrites the collection details, this endpoint allows for selective modification of specific details such as fixing any typos present in the collection name as well as facilitating addition or removal of attributes - [Syncing Collections Using Delta Files](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/collections/syncing-collections-using-delta-files.md) - [Update children of collection](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/collections/update-children-of-collection.md): This endpoint is primarily used to change display order of children collection. - [Update collection](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/collections/update-collection.md): With this endpoint, you can update details of a single collection, such as add or remove sub-collections, add validation rules for attributes, reorder collections, and more. **Note**:
1. This endpoint replaces the existing details.
2. To avoid impacting the entire data, for minor updates, use the Partially update collection endpoint instead - `PATCH /collections/{id}`. - [Data Ingestion Best Practices](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/data-ingestion-best-practices.md) - [Configuring Product Catalog](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/developer-guide/configuring-product-catalog.md) - [Examples](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/developer-guide/examples.md) - [Introduction](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/developer-guide/introduction.md) - [Postman Collections](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/developer-guide/postman-collections.md) - [Create file object and get file upload location](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/files/create-file-object-and-get-file-upload-location.md): This endpoint creates a file object by specifying the import file's `type`, `name`, and `locale` in the request body. The response will include the URL location to upload the file. - [Download a file by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/files/download-a-file-by-id.md): Use this endpoint to get a download link for imported file, which you can use to review or update the file . **Note**: The link is valid only for five minutes. - [Generate the import template](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/files/generate-the-import-template.md): Bulk import must be in a standardized format. Using this endpoint, you can generate the template required to bulk import attribute, category, collection, item, and/or bundle. - [Get files available for a merchant](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/files/get-files-available-for-a-merchant.md): Get files available for a merchant. This endpoint can be used to search for files using file names or file IDs. **Note**: Query parameter `ids` can't be combined with any other query parameters and pagination isn't supported when `ids` query is used. - [Add products](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/general-product-operations/add-products.md): At fabric, the term products refers to items, variants, and/or bundles. With this endpoint, you can add up to 25 products. Refer to the examples added for each type. **Note**:
1. If product type is Variant, they can be added using either SKU or ID.
2. When product type is Item, either `parentCategoryId` or `parentCategorySKU` must be specified.
3. When product `type` is Bundle, items in a bundle can be added using either SKU or ID.
4. In the response you can see the products that are added successfully and the ones that couldn't be added. - [Bulk reassign products to a different category using filter conditions](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/general-product-operations/bulk-reassign-products-to-a-different-category-using-filter-conditions.md): To enhance product visibility or improve product organization, you may want to reassign products to a different category. With this endpoint, you can asynchronously reassign products to a different category. Instead of waiting for results through the API response, you'll gets notified via email whether the products were successfully reassigned. - [Delete products](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/general-product-operations/delete-products.md): To keep the product list (catalog) up to date and current, it's important to remove products that are discontinued permanently. With this endpoint, you can delete up to 25 products either by SKUs or IDs. **Note**:
1. Unless all products are deleted, this endpoint fails.
2. To delete a single product, you can use either the ID-based (`DELETE /products/{id}`) or SKU-based endpoint (`DELETE /products/sku/{sku}`). - [Find products](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/general-product-operations/find-products.md): To find specific products for review or reports, you need to specify the criteria for the search. With this endpoint, you can find products (items, variants, and bundles) based on ID or SKU, type, category, and other criteria. - [Get products list](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/general-product-operations/get-products-list.md): You may have to review products to review or analyze them or create certain reports. This endpoint gets a paginated list of products (items, variants, and bundles) for the specified `locales`. **Note**: Specify product IDs to get only those products. Or, you may mention `offset` and `limit` to refine the search results. When they're not specified, by default, you'll get up to 10 products. - [Reassign products to a different category, synchronously.](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/general-product-operations/reassign-products-to-a-different-category-synchronously.md): To enhance product visibility or improve product organization, you may want to reassign products to a different category. With this endpoint, you can synchronously reassign up to 25 products to a different category. The response will show a list of successful and unsuccessful reassignments - [Update products](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/general-product-operations/update-products.md): With this endpoint, you can update details of multiple products, which could be items, variants, and bundles. **Note**:
1. When product type is `Variant`, it can be added either via SKU or ID.
2. When product type is `Item`, either the `parentCategoryId` or `parentCategorySKU` must be specified.
3. When product type is `Bundle`, the associated items or variants can be added either via SKU or via ID.
4. At least one product must be specified. - [Cancel background jobs using job IDs](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/jobs/cancel-background-jobs.md): Cancel any in progress or scheduled background job by providing the job ID. Currently only supports item and variant import jobs. - [Get jobs related to products](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/jobs/get-jobs-related-to-products.md): Get a paginated list of jobs related to products by specifying the query parameters such as job `ids`, `type`. You can refine the results by specifying `offset` and `limit`. **Note**:
1. Query parameter `ids` can't be combined with the rest of the query parameters and when it's specified, pagination isn't supported.
2. Query parameter `inputFileIds` supports up to 15 comma-separated file IDs and it can be combined only with the query parameter `lastJobOnly`. Pagination isn't supported when this parameter is used. - [Initiate job to export items and variants](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/jobs/initiate-job-to-export-items-and-variants.md): Use this endpoint to trigger a job to export items and variants, by ids. - [Initiate job to export items and variants](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/jobs/initiate-job-to-export-items-and-variants-1.md): Use this endpoint to trigger a job to export items and variants based on the specified filter conditions. - [Search jobs](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/jobs/search-background-jobs.md): Get a paginated list of jobs related to products and collections by specifying the request body. You need to specify the criteria for the search such as job `id`, `type`, `status`, `collectionId`, `inputFileId`. - [Add product](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/add-product.md): At fabric, the term products refers to items, variants, and/or bundles. - [Add products to bundle by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/add-products-to-bundle-by-id.md): Creating a bundle of two or more complementary products, sold as a single package, is a widely adopted sales and marketing strategy. For example, a laptop is bundled with a carrying case and wireless mouse. This makes it convenient for shoppers to purchase them together. With this endpoint, you can add up to 25 products in a bundle that can be sold together. **Note**:
1. At least one product must be added.
2. If you don't have product ID, use the corresponding SKU-based endpoint - `POST /products/sku/{sku}/bundles/actions/attach`. - [Add variants to products by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/add-variants-to-products-by-id.md): Variants are the different options of an item such as size, color, and materials. For example, there are 12 variants for a laptop that comes in three sizes (13, 15, and 17 inches) and four colors (red, blue, grey, and white). By adding variants to products, you can offer more options to shoppers. With this endpoint, you can add up to 25 variants to an existing product. **Note**:
1. At least one variant must be specified.
2. If you don't have product ID, use the corresponding SKU-based endpoint - `POST /products/sku/{sku}/variants/actions/attach`. - [Change product category](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/change-product-category.md): This endpoint lets you change a product from one category to another. When managing a large number of products, this endpoint gives you the flexibility to organize products easily. - [Delete product by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/delete-product-by-id.md): To keep the product list (catalog) up to date and current, it's important to remove products that are discontinued permanently. With this endpoint, you can delete a product (Item, Bundle, or Variant) by ID. Using `deleteVariants` as query parameter, you an optionally specify if you want to delete the associated variants as well. **Note**: If you don't have product ID, use the corresponding SKU-based endpoint - `DELETE /products/sku/{sku}`. - [Get product by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/get-product-by-id.md): With this endpoint, you can get details of a product (item, bundle, or variant) by ID. The response includes the product's attributes and its variants. You can optionally specify `locales` to get products for specific regions. **Note**: If you don't have product ID, use the corresponding SKU-based endpoint - `GET /products/sku/{sku}` - [Get product variants by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/get-product-variants-by-id.md): Variants are different options of an item such as size, color, and materials. For example, there are 12 variants for a laptop that comes in three sizes (13, 15, and 17 inches) and four colors (red, blue, grey, and white). By adding variants to products, you can offer more options to shoppers . **Note**:
1. At least one variant must be specified.
2. If you don't have product ID, use the corresponding SKU-based endpoint - `GET /products/sku/{sku}/variants`.
3. The `status` parameter is applicable to the `id` passed in path parameter and not for the variants. That is, the variants returned as part of the response are either the variants attached to the Live or Draft version of the product based on the `status` parameter. - [Get products in a bundle by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/get-products-in-a-bundle-by-id.md): Bundle is a collection of products that are sold together as a single package. For example, a laptop is bundled with a carrying case and a wireless mouse to be sold as a package. This endpoint gets a paginated list of products by ID. **Note**:
1. You can refine the results by specifying `offset` and `limit` values. When they're not specified, by default, you'll get up to 10 products.
2. If you don't have product ID, use the corresponding SKU-based endpoint - `GET /products/sku/{sku}/bundles`.
3. The `status` parameter is applicable to the `id` passed in path parameter and not for bundles. That is, bundles returned as part of the response are either the bundles attached to the Live or Draft version of the product based on the `status` parameter. - [Partially update product attributes by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/partially-update-product-attributes-by-id.md): Product attributes are the objective and factual descriptions of products that shoppers see when they browse through an e-commerce platform. Attributes may be technical specifications like size, weight, etc., design specifications like color, material, etc., or basic specifications such as name, description, ID, etc. With this endpoint, you can partially update attributes of a given product. **Note**:
1. This endpoint is recommended over `PUT /products/{id}/attributes` (Update product attributes by ID) if you want to update only specific attributes without affecting the others.
2. If you don't have product ID, use the corresponding SKU-based endpoint - `PATCH /products/sku/{sku}/attributes`. - [Product Catalog API](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/products-api.md) - [Publish product by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/publish-product-by-id.md): A newly added product can be in `Published` or `Draft` status. With this endpoint, you can publish the Draft version of a product. - [Remove products from a bundle by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/remove-products-from-a-bundle-by-id.md): When one or more products in a bundle are discontinued or no longer required, you don't want them to appear in the bundle. With this endpoint, you can remove up to 25 products by ID. **Note**
1. Products are only detached from the given product, not deleted. They can be added to the same or another product, at a later point.
2. At least one product must be specified.
3. If you don't have product ID, use the corresponding SKU-based endpoint - `POST /products/sku/{sku}/bundles/actions/detach`. - [Remove variants by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/remove-variants-by-id.md): When one or more variants of a product are discontinued or no longer required, you don't want them to appear as options for the product. This endpoint provides the flexibility to remove up to 25 variants by ID and manage options efficiently. **Note**:
1. Variants are only detached from the given product, not deleted. They can be reattached to the same or another product at a later point.
2. At least one variant must be specified.
3. If you don't have product ID, use the corresponding SKU-based endpoint - `POST /products/sku/{sku}/variants/actions/detach`. - [Unpublish product by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/unpublish-product-by-id.md): Due to changes in market, you may have to remove a product from being live. With this endpoint, you can unpublish product. - [Update product](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/update-product.md): With this endpoint, you can update details of a single product, which could be an items, variant, or a bundles. **Note**:
1. When product type is `Variant`, it can be added either using SKU or ID.
2. When product type is `Item`, either `parentCategoryId` or `parentCategorySKU` must be specified.
3. When product type is Bundle, associated items or variants can also be added either using SKU or via ID.
4. At least one product must be specified. - [Update product attributes by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/update-product-attributes-by-id.md): Product attributes are the objective and factual descriptions of products that shoppers see when they browse through an e-commerce platform. Attributes may be technical specifications like size, weight, etc., design specifications like color, material, etc., or basic specifications such as name, description, ID, etc. This endpoint is used to update product attributes, completely replacing the existing ones. **Note**:
1. This endpoint is recommended over `PATCH /products/{id}/attributes`, if the update involves replacing all the attributes. If there are any missing or null fields in the request, the original values will be replaced with empty ones.
2. If you don't have product ID, use the corresponding SKU-based endpoint - `PUT /products/sku/{sku}/attributes`. - [Add products to bundle by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/add-products-to-bundle-by-sku.md): Creating a bundle of two or more complementary products, sold as a single package, is a widely adopted sales and marketing strategy. For example, a laptop is bundled with a carrying case and wireless mouse. This makes it convenient for shoppers to purchase them together. With this endpoint, you can add up to 25 products in a bundle that can be sold together. **Note**:
1. At least one product must be added.
2. If you don't have product `sku`, use the corresponding ID-based endpoint - `POST /products/{id}/bundles/actions/attach`. - [Add variants to products by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/add-variants-to-products-by-sku.md): Variants are the different options of an item such as size, color, and materials. For example, there are 12 variants for a laptop that comes in three sizes (13, 15, and 17 inches) and four colors (red, blue, grey, and white). By adding variants to products, you can offer more options to shoppers. With this endpoint, you can add up to 25 variants to an existing product **Note**:
1. At least one variant must be specified.
2. If you don't have product ID, use the corresponding ID-based endpoint - `POST /products/{id}/variants/actions/attach`. - [Delete product by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/delete-product-by-sku.md): To keep the product list (catalog) up to date and current, it's important to remove products that are discontinued permanently. With this endpoint, you can delete a product (Item, Bundle, or Variant) by SKU. Using `deleteVariants` as query parameter, you an optionally specify if you want to delete the associated variants as well. **Note**: If you don't have product SKU, use the corresponding ID-based endpoint - `DELETE /products/{id}`. - [Get product by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/get-product-by-sku.md): You may want to periodically review details of a product to ensure they're correct. This endpoint gets details of a product (item, bundle, or variant) by SKU. The response includes products attributes and its variants. You can optionally specify `locales` to get products for specific regions. **Note**: If you don't have product SKU, use the corresponding ID-based endpoint - `GET /products/{id}`. - [Get product variants by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/get-product-variants-by-sku.md): Variants are different options of an item such as size, color, and materials. For example, there are 12 variants for a laptop that comes in three sizes (13, 15, and 17 inches) and four colors (red, blue, grey, and white). By adding variants to products, you can offer more options to shoppers **Note**:
1. At least one variant must be specified.
2. If you don't have product ID, use the corresponding ID-based endpoint - `/products/{id}/variants`.
3. The `status` parameter is applicable to the `id` passed in path parameter and not for variants. That is, the variants returned as part of the response are the variants attached to either the Live or Draft version of the product based on the `status` parameter. - [Get products by SKUs](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/get-products-by-skus.md): Get a paginated list of product (Item, Bundle, or Variant) by SKU, including the attributes and variants. You can optionally specify `locales` to get products for specific regions. **Note**:
1. You can refine the results by specifying `offset` and `limit` values. If you don't specify them, by default, you'll get up to 10 products.
2. If you don't have product SKU, use the corresponding ID-based endpoint - `GET /products/{id}`. - [Get products in a bundle by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/get-products-in-a-bundle-by-sku.md): Bundle is a collection of products that are sold together as a single package. For example, a laptop is bundled with a carrying case and a wireless mouse to be sold as a package. This endpoint gets a paginated list of products by ID. **Note**:
1. You can refine the results by specifying `offset` and `limit` values. When they're not specified, by default, you'll get up to 10 products.
2. If you don't have product SKU, use the corresponding ID-based endpoint - `GET /products/{id}/bundles`.
3. The `status` parameter is applicable to the `id` passed as path parameter and not for bundles. That is, the bundles returned in the response are the bundles attached to either the Live or Draft version of the product based on the `status` parameter. - [Partially update product by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/partially-update-product-by-sku.md): Product attributes are the objective and factual descriptions of products that shoppers see when they browse through an e-commerce platform. Attributes may be technical specifications like size, weight, etc., design specifications like color, material, etc., or basic specifications such as name, description, ID, etc. This endpoint is used to partially update attributes of the given product attributes. **Note**:
1. This endpoint is recommended over `PUT /products/sku/{sku}/attributes` (Update product attributes by SKU) if you want to update only specific attributes without affecting the others.
2. If you don't have product SKU, use the corresponding ID-based endpoint - `PATCH /products/{id}/attributes`. - [Publish product by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/publish-product-by-sku.md): A newly added product can be in `Published` or `Draft` status. With this endpoint, by specifying `sku`, you can publish a product in Draft status. - [Remove product variants by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/remove-product-variants-by-sku.md): When one or more variants of a product are discontinued or no longer required, you don't want them to appear as options. This endpoint provides the flexibility to remove up to 25 variants by SKU and manage product options, efficiently. **Note**:
1. Variants are only detached from the given product, not deleted. They can be reattached to the same or another product, at a later point.
2. At least one variant must be specified.
3. If you don't have product SKU, use the corresponding ID-based endpoint - `POST /products/{id}/variants/actions/detach`. - [Remove products from a bundle by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/remove-products-from-a-bundle-by-sku.md): When one or more products in a bundle are discontinued or no longer required, you don't want them to appear in the bundle. With this endpoint, you can remove up to 25 products by SKU. **Note**
1. Products are only detached from the given product, not deleted. They can be added to the same or another product, at a later point.
2. At least one product must be specified.
3. If you don't have product ID, use the corresponding SKU-based endpoint - `POST /products/{id}/bundles/actions/detach`. - [Unpublish product by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/unpublish-product-by-sku.md): Due to changes in market, you may have to remove a product from being live. With this endpoint, you can unpublish a product by specifying `sku`. - [Update product attributes by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/update-product-attributes-by-sku.md): Product attributes are the objective and factual descriptions of products that shoppers see when they browse through an e-commerce platform. Attributes may be technical specifications like size, weight, etc., design specifications like color, material, etc., or basic specifications such as name, description, ID, etc. This endpoint is used to update product attributes, completely replacing the existing ones. **Note**:
1. This is recommended over `PATCH /products/sku/{sku}/attributes`, if the update involves replacing all the attributes. If there are any missing or null fields in the request, the original values will be replaced with empty ones.
2. If you don't have product SKU, use the corresponding ID-based endpoint - `PUT /products/{id}/attributes`. - [Update product SKUs](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/update-product-skus.md): You may need to update the SKUs of one or more products if the products have undergone significant improvements, and you need a way to differentiate between the updated version and the previous one. Or, you may want to address a typographical error or inconsistencies in the SKU naming conventions. This endpoint updates SKUs for up to 25 products. **Note**: Unless all SKUs are updated, the endpoint will fail. - [Product Catalog - Attributes API](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/products---attributes-api.md) - [Product Catalog - Files and Jobs API](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/products---files-and-jobs-api.md) - [Product Catalog - Published Product Catalog API](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/products---published-products-api.md) - [Product Catalog API - Overview](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/products-api---overview.md) - [Get collections by product ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/published-products-by-id/get-collections-by-product-id.md): On your Storefront products are organized or grouped in logical groups called Collections. The main purpose of Collection is distribution management by displaying products on your website based on separate browsing structures required to achieve specific merchandising objectives, such as organizational requirements, multi-regional assortments, multi-channel assortments, and collections. This endpoint gets the collection details of a published product by ID. You can refine your search results by specifying query parameters - `collectionIds` and `collectionRootName` **Note**:
1. You can narrow down the results by specifying `offset` and `limit`. When they're not specified, by default, you'll get up to 10 products.
2. If you don't have product ID, use the corresponding item ID-based or SKU-based endpoints. - [Get products by IDs](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/published-products-by-id/get-products-by-ids.md): Shoppers may want to view the products they've already identified or bookmarked, or you may want to promote a particular set of products as part of promotions. This endpoint get details of published products with or without variants, categories, bundle products, and collections. You can specify multiple comma-separated product `ids`. Using this endpoint, you can show up to 25 products on your Storefront. **Note**: If you don't have product ID, use the corresponding item ID-based or SKU-based endpoints. - [Get products in a bundle by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/published-products-by-id/get-products-in-a-bundle-by-id.md): A bundle is a collection of products that are sold together as a single package. For example, a laptop is bundled with a carrying case and a wireless mouse to be sold as a package. This endpoint gets a paginated list of published products in a bundle by bundle ID. You can refine your search results by specifying query parameters - `excludeBundleProducts`, `excludeCollections`, `excludeCategories` and `excludeVariants` **Note**:
1. You can refine the results by specifying `offset` and `limit`. When they're not specified, by default, you'll get up to 10 products.
2. If you don't have product ID, use the corresponding item ID-based or SKU-based endpoints. - [Get published product by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/published-products-by-id/get-published-product-by-id.md): Your Storefront must displays all the relevant information for shoppers to make an informed purchase decision. This endpoint gets details of a published product (item, bundle, or variant) by ID, which can be used to display product details on your Storefront. **Note**: If you don't have product ID, use the corresponding SKU-based or item ID-based endpoints. - [Get variants of published product by ID](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/published-products-by-id/get-variants-of-published-product-by-id.md): Variants are the different versions of a product with different sizes, colors, or materials. For example, there are 12 variants of a laptop that comes in three sizes (13, 15, and 17 inches) and four colors (red, blue, grey, and white). By adding variants to products, you can offer shoppers more options. This endpoint gets a paginated list of variants of a published product by ID. **Note**:
1. You can narrow down the search results by specifying `offset` and `limit`. When they're not specified, by default you'll get up to 10 records.
2. If you don't have product ID, use the corresponding SKU-based or item ID-based endpoints. - [Get bundle products by bundle SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/published-products-by-sku/get-bundle-products-by-bundle-sku.md): A bundle is a collection of products that are sold together as a single package. For example, a laptop is bundled with a carrying case and a wireless mouse to be sold as a package. This endpoint gets a paginated list of published products in a bundle by bundle SKU. **Note**:
1. You can refine the results by specifying `offset` and `limit`. When they're not specified, by default, you'll get up to 10 products.
2. If you don't have product SKU, use the corresponding item ID-based or product ID-based endpoints. - [Get collections by product SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/published-products-by-sku/get-collections-by-product-sku.md): On your Storefront products are organized or grouped in logical groups called Collections. The main purpose of collection is distribution management by displaying products on your website based on separate browsing structures required to achieve specific merchandising objectives, such as organizational requirements, multi-regional assortments, multi-channel assortments, and collections. This endpoint gets the collection details of a published product by ID. You can refine your search results by specifying query parameters - `collectionIds` and `collectionRootName`. **Note**: If you don't have SKU, use the corresponding item ID-based or product ID-based endpoints. - [Get published product by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/published-products-by-sku/get-published-product-by-sku.md): Your Storefront must displays all the relevant information for shoppers to help them make an informed purchase decision. This endpoint gets details of a published product (item, bundle, or variant) by SKU, which can be used to display product details on your Storefront. **Note**: If you don't have product SKU, use the corresponding item ID-based or product ID-based endpoints. - [Get published products by SKUs](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/published-products-by-sku/get-published-products-by-skus.md): Shoppers may want to view the products they've already identified or bookmarked, or you want to promote a particular set of products as part of promotions. This endpoint gets multiple published products based on `skus` (comma-separated values) and is useful to show product list (up to 25 products) on your Storefront. **Note**:
1. Using the examples you can see separate response for items, variants, and bundles.
2. If you don't have product SKU, use the corresponding item ID-based or product ID-based endpoints. - [Get variants of published products by SKU](https://developer.fabric.inc/v3/product-catalog/api-reference/product-catalog/published-products-by-sku/get-variants-of-published-products-by-sku.md): Variants are different versions of a product with different sizes, colors, or materials. For example, there are 12 variants of a laptop that comes in three sizes (13, 15, and 17 inches) and four colors (red, blue, grey, and white). By adding variants to products, you can offer shoppers more options. This endpoint gets a paginated response of variants of a published product by SKU. **Note**:
1. You can refine results by specifying `offset` and `limit`. When they're not specified, by default you'll get up to 10 records.
2. If you don't have product SKU, use the corresponding item ID-based or product ID-based endpoints. - [Bundles Overview](https://developer.fabric.inc/v3/product-catalog/user-guides/catalog-connector/bundles-overview.md) - [Importing Bundles](https://developer.fabric.inc/v3/product-catalog/user-guides/catalog-connector/importing-bundles.md) - [Importing Items](https://developer.fabric.inc/v3/product-catalog/user-guides/catalog-connector/importing-items.md) - [Items Overview](https://developer.fabric.inc/v3/product-catalog/user-guides/catalog-connector/items-overview.md) - [Catalog Connector Overview](https://developer.fabric.inc/v3/product-catalog/user-guides/catalog-connector/overview.md) - [Searching, Filtering, and Sorting Bundles](https://developer.fabric.inc/v3/product-catalog/user-guides/catalog-connector/searching-filtering-sorting-bundles.md) - [Searching, Filtering, and Sorting Items](https://developer.fabric.inc/v3/product-catalog/user-guides/catalog-connector/searching-filtering-sorting-items.md) - [Viewing Bundle Details](https://developer.fabric.inc/v3/product-catalog/user-guides/catalog-connector/viewing-bundle-attributes-variants-channels.md) - [Viewing Bundle Import History](https://developer.fabric.inc/v3/product-catalog/user-guides/catalog-connector/viewing-bundle-import-history.md) - [Viewing Item Details](https://developer.fabric.inc/v3/product-catalog/user-guides/catalog-connector/viewing-item-attributes-variants-channels.md) - [Viewing Item Import History](https://developer.fabric.inc/v3/product-catalog/user-guides/catalog-connector/viewing-item-import-history.md) - [Adding a Boolean Attribute](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-boolean-attribute.md) - [Adding a Boolean Attribute](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-boolean-attribute2.md) - [Adding a Date Attribute](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-date-attribute.md) - [Adding a Date Attribute](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-date-attribute2.md) - [Adding a List of Values Attribute](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-list-of-values-attribute.md) - [Adding a Number Only Attribute](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-number-only-attribute.md) - [Adding a Number Only Attribute](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-number-only-attribute2.md) - [Adding a Serial Attribute](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-serial-attribute.md) - [Adding a Text Attribute](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-text-attribute.md) - [Adding a Text Attribute](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-text-attribute2.md) - [Category Attributes Overview](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/category-attributes-overview.md) - [Importing Product Attributes](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/importing-product-attributes.md) - [Managing Category Attributes](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/managing-category-attributes.md) - [Managing Product Attributes](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/managing-product-attributes.md) - [Product Attributes Overview](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/product-attributes-overview.md) - [Searching and Sorting Category Attributes](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/searching-and-sorting-category-attributes.md) - [Searching and Sorting Product Attributes](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/attributes/searching-and-sorting-product-attributes.md) - [Background Jobs](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/background-jobs/background-jobs.md) - [Managing Background Jobs](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/background-jobs/managing-background-jobs.md) - [Viewing Background Jobs History](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/background-jobs/viewing-background-jobs-history.md) - [Adding a Category](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/categories/adding-a-category.md) - [Importing Categories](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/categories/importing-categories.md) - [Managing Categories](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/categories/managing-categories.md) - [Categories](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/categories/overview.md) - [Adding Category Attributes to a Collection](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/collections/adding-category-attributes.md) - [Collections](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/collections/collections.md) - [Creating a Collection](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/collections/creating-a-collection.md) - [Importing Collections](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/collections/importing-collections.md) - [Managing Collections](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/collections/managing-collections.md) - [Data Ingestion Best Practices](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/data-ingestion-best-practices.md) - [Adding a Bundle](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/bundles/adding-a-bundle.md) - [Bundles Overview](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/bundles/bundles.md) - [Editing a Bundle](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/bundles/editing-a-bundle.md) - [Importing Bundles](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/bundles/importing-bundles.md) - [Searching, Filtering, and Sorting Bundles](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/bundles/searching-filtering-sorting-bundles.md) - [Adding an Item](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/items/adding-an-item.md) - [Adding Item Variants](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/items/adding-item-variants.md) - [Bulk Operations for Items](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/items/bulk-operations-items.md) - [Editing an Item](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/items/editing-an-item.md) - [Importing Items](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/items/importing-items.md) - [Items Overview](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/items/items.md) - [Searching, Filtering, and Sorting Items](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/list/items/searching-filtering-sorting-items.md) - [Overview](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/overview.md): fabric Product Catalog is a data organization tool that enables merchants to build a centralized source of product information. This information can include technical specifications such as size and weight, design specifications such as color and material, and generic details such as name, description, and ID. - [Attribute Groups Overview](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/settings/attribute-groups-overview.md) - [Attribute Mapping Overview](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/settings/attribute-mapping-overview.md) - [Creating Attribute Groups](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/settings/creating-attribute-groups.md) - [Mapping Attributes](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/settings/how-to-map-attributes.md) - [Settings](https://developer.fabric.inc/v3/product-catalog/user-guides/product-catalog/settings/settings.md) - [Feedback and Contact](https://developer.fabric.inc/v3/release-notes/feedback-contact.md) - [Commerce Platform](https://developer.fabric.inc/v3/release-notes/july2024/commerce-platform.md) - [Dropship](https://developer.fabric.inc/v3/release-notes/july2024/dropship.md) - [Fulfillment](https://developer.fabric.inc/v3/release-notes/july2024/fulfillment.md) - [Offers](https://developer.fabric.inc/v3/release-notes/july2024/offers.md) - [Orders](https://developer.fabric.inc/v3/release-notes/july2024/orders.md) - [Product Catalog](https://developer.fabric.inc/v3/release-notes/july2024/product-catalog.md) - [Release Summary](https://developer.fabric.inc/v3/release-notes/july2024/release-summary.md) - [Dropship](https://developer.fabric.inc/v3/release-notes/oct2024/dropship.md) - [Fulfillment](https://developer.fabric.inc/v3/release-notes/oct2024/fulfillment.md) - [Offers](https://developer.fabric.inc/v3/release-notes/oct2024/offers.md) - [Orders](https://developer.fabric.inc/v3/release-notes/oct2024/orders.md) - [Product Catalog](https://developer.fabric.inc/v3/release-notes/oct2024/product-catalog.md) - [Release Summary](https://developer.fabric.inc/v3/release-notes/oct2024/release-summary.md) - [November 2023](https://developer.fabric.inc/v3/release-notes/sample.md) - [Completing Store Fulfillments](https://developer.fabric.inc/v3/store-fulfillment/completing-store-fulfillments.md) - [Transferring Store Inventory](https://developer.fabric.inc/v3/store-fulfillment/creating-transfers.md) - [Editing Store Fulfillments](https://developer.fabric.inc/v3/store-fulfillment/editing-store-fulfillments.md) - [Editing Store Inventory Transfers](https://developer.fabric.inc/v3/store-fulfillment/editing-transfers.md) - [Order Lookup](https://developer.fabric.inc/v3/store-fulfillment/order-lookup.md) - [Completing Customer Handoffs](https://developer.fabric.inc/v3/store-fulfillment/picking-up-orders.md) - [Store Inventory Lookup](https://developer.fabric.inc/v3/store-fulfillment/store-inventory-lookup.md) - [Changing the Store Location](https://developer.fabric.inc/v3/store-fulfillment/updating-store-location.md) - [Viewing Store Adjustments](https://developer.fabric.inc/v3/store-fulfillment/viewing-adjustments.md) - [Viewing Customer Handoffs](https://developer.fabric.inc/v3/store-fulfillment/viewing-customer-pickups.md) - [Viewing Store Fulfillments](https://developer.fabric.inc/v3/store-fulfillment/viewing-fulfillments.md) - [Viewing Store Receivings](https://developer.fabric.inc/v3/store-fulfillment/viewing-receivings.md) - [Viewing Store Transfers](https://developer.fabric.inc/v3/store-fulfillment/viewing-transfers.md)