{ "opencollection": "1.0.0", "info": { "name": "fabric Orders API", "version": "3.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Create New Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Update an Order’s Status with State Transition", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderIdentifierType/:orderIdentifierValue/actions/update-status", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdentifierType", "value": "ORDER0001", "type": "path", "description": "The type of identifier used to locate the order. Supported values are `order-id`, `order-number`, and `order-external-id`." }, { "name": "orderIdentifierValue", "value": "ORDER0001", "type": "path", "description": "The value of the order identifier corresponding to the specified `orderIdentifierType`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs a state transition on an order using the order state machine. The provided status code must correspond to a valid action available from the order’s current state. Orders that are already in or beyond the **ORDER_ALLOCATED** state cannot be updated using this endpoint." }, { "info": { "name": "Update Order Fees and Taxes", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderIdentifierType/:orderIdentifierValue/actions/update-fees-and-taxes", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdentifierType", "value": "order-id", "type": "path", "description": "The type of identifier used to locate the order. Supported values: `order-id`, `order-number`, `order-external-id`." }, { "name": "orderIdentifierValue", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "The value of the order identifier that corresponds to `orderIdentifierType`." }, { "name": "overrideAllArrayFields", "value": "true", "type": "query", "description": "Controls how array fields in the request body are applied. When true, arrays provided in the payload replace the existing arrays on the order. When false, array updates are merged/partially applied based on the service's update behavior." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Recalculates and updates fee and tax totals for an existing order. The request payload allows you to provide updated fee and tax values at the order, item, and ship-to levels. Only fields included in the payload are applied. Use `overrideAllArrayFields` to control whether array fields in the payload replace the existing arrays or are merged." }, { "info": { "name": "Update a Ship-to Address for a Specific Shiptoid", "type": "http" }, "http": { "method": "PUT", "url": "https://api.fabric.inc/v3/orders/:orderIdentifierType/:orderIdentifierValue/ship-info/:shipToId/ship-to-address", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdentifierType", "value": "order-id", "type": "path", "description": "The type of identifier used to locate the order. Supported values: `order-id`, `order-number`, `order-external-id`." }, { "name": "orderIdentifierValue", "value": "ORDER0001", "type": "path", "description": "The value of the order identifier that corresponds to the `orderIdentifierType`." }, { "name": "shipToId", "value": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569", "type": "path", "description": "Unique identifier (UUID) of the ship-to location within the order (`shipInfo`)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the ship-to address for a specific `shipToId` on an order. Only the address fields present in the payload are updated. If address enrichment (for example Google Maps) is configured, address validation and automatic latitude/longitude enrichment may run. If you are using Geography and Zones, the fulfillment zone is updated and a soft reservation is triggered to move inventory to the correct network." }, { "info": { "name": "Update Bill-to Address for a Specific Payment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.fabric.inc/v3/orders/:orderIdentifierType/:orderIdentifierValue/payments/:paymentCounter/bill-to-address", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdentifierType", "value": "order-id", "type": "path", "description": "The type of identifier used to locate the order. Supported values: `order-id`, `order-number`, `order-external-id`." }, { "name": "orderIdentifierValue", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "The value of the order identifier that corresponds to `orderIdentifierType`." }, { "name": "paymentCounter", "value": "1", "type": "path", "description": "The sequential counter identifying the specific payment within the order (used to select which payment's bill-to address to update)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the bill-to address for a specific payment on an order, identified by `paymentCounter`. Only address fields included in the payload are updated." }, { "info": { "name": "Add a Payment Log Entry for a Specific Payment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.fabric.inc/v3/orders/:orderIdentifierType/:orderIdentifierValue/payments/:paymentCounter/payment-logs", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdentifierType", "value": "order-id", "type": "path", "description": "The type of identifier used to locate the order. Supported values: `order-id`, `order-number`, `order-external-id`." }, { "name": "orderIdentifierValue", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "The value of the order identifier that corresponds to `orderIdentifierType`." }, { "name": "paymentCounter", "value": "1", "type": "path", "description": "The sequential counter identifying the specific payment within the order (used to select which payment to attach the log to)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new payment log entry to the logs for a specific payment on an order, identified by `paymentCounter`. Payment logs capture when a payment is charged or credited, and include provider response details and metadata. Only fields present in the payload are applied." }, { "info": { "name": "Update Order Attributes by Order Identifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderIdType/:orderIdValue/actions/update-attributes", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdType", "value": "order-id", "type": "path", "description": "The type of order identifier used to locate the order. \nSupported values: \n- `order-id` \n- `order-number` \n- `order-external-id`\n" }, { "name": "orderIdValue", "value": "ORDER0001", "type": "path", "description": "The value of the specified order identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates order attributes, typically used by the integration layer to modify \nor synchronize external system–related information. \n\n**Note:** \n- Use this endpoint if you have the order ID, order number, or external order ID. \n- If you only have an order number, set `orderIdType` to `order-number`.\n" }, { "info": { "name": "Update Customer Details for Given Order Ids", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/actions/update-customer", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.

" }, { "info": { "name": "Get Order by Order Number", "type": "http" }, "http": { "method": "GET", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "Order-320000001", "type": "path", "description": "Merchant-defined order identifier" } ] }, "docs": "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}`.

" }, { "info": { "name": "Update Shipping Information for an Existing Order by Order Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/update-attributes", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "Order-320000001", "type": "path", "description": "The merchant-defined order identifier provided during the Create Order - `POST /orders` endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The following endpoint is used to update attributes by order number." }, { "info": { "name": "Search for Orders", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/search", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "offset", "value": "0", "type": "query", "description": "Number of records to skip before returning records. For example, When `offset=20`, `limit=10` returns records 21-30." }, { "name": "limit", "value": "10", "type": "query", "description": "Maximum number of records per page" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Search and retrieve orders using filter parameters such as order `type`, status, date range, and more. This endpoint allows customers and merchants to query past orders for review, analysis, or support.

Filters must be provided in the request body. You can paginate results using `offset` and `limit`. If pagination parameters are not specified, the default response returns up to 10 orders.

" }, { "info": { "name": "Get Order by Order ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.fabric.inc/v3/orders/:orderId", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "24-character system-generated order ID returned in the response of Create Order endpoint - `POST /orders`." } ] }, "docs": "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}`.

" }, { "info": { "name": "Update Order Attributes", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/update-attributes", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "123k4h123k", "type": "path", "description": "The merchant-defined order identifier provided during the Create Order - `POST /orders` endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Updates Order Pick-up Details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.fabric.inc/v3/orders/:orderId/ship-info/:shipToId/pickup", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "24-character system-generated order ID returned in the response of Create Order - `POST /orders` endpoint." }, { "name": "shipToId", "value": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569", "type": "path", "description": "Unique ID for the given `shipInfo`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.

" } ] }, { "info": { "name": "Payments", "type": "folder" }, "items": [ { "info": { "name": "Authorize Order Payments", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/actions/authorize-payments", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is used synchronously or asynchronously for authorizing order payments pending for authorization." }, { "info": { "name": "Update Status of Order Payment by Order Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/update-payment-status", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "123k4h123k", "type": "path", "description": "Merchant-defined order identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.

" }, { "info": { "name": "Update Order Payment Status by Order ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/update-payment-status", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "24-character system-generated ID. It is returned in the response of Create Order - `POST /orders` endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.

" } ] }, { "info": { "name": "Cancellations", "type": "folder" }, "items": [ { "info": { "name": "Cancel Order by Order Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/cancel", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "123k4h123k", "type": "path", "description": "Merchant-defined order identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancels an order when a customer's cancellation request is determined to be eligible. \nThis endpoint processes the cancellation based on the provided **order number**. \n\n**Note:** \n- Use this endpoint only if you have the order number. \n- If you have the order ID or external order ID instead, use the corresponding \n identifier-based endpoint: `POST /orders/{orderIdType}/{orderIdValue}/actions/cancel`.\n" }, { "info": { "name": "Get Order Cancellation Eligibility by Order Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/check-cancel-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "123k4h123k", "type": "path", "description": "The merchant-defined order identifier." }, { "name": "policyName", "value": "", "type": "query", "description": "The merchant-defined cancellation policy. When omitted, the default policy is used." }, { "name": "lineItemIds", "value": "", "type": "query", "description": "The line item IDs. If specified, you'll get cancellation eligibility of the given line items. If omitted, you'll get cancellation eligibility of each item in the order." } ] }, "docs": "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, its 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.

" }, { "info": { "name": "Cancel Order by Order Identifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderIdType/:orderIdValue/actions/cancel", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdType", "value": "order-id", "type": "path", "description": "The type of order identifier used to locate the order. \nSupported values: \n- `order-id` \n- `order-number` \n- `order-external-id`\n" }, { "name": "orderIdValue", "value": "ORDER0001", "type": "path", "description": "The value of the specified order identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancels an order when a customer's cancellation request is determined to be eligible. \nThis endpoint processes the cancellation based on the provided order identifier. \n\n**Note:** \n- Use this endpoint if you have the order ID, order number, or external order ID. \n- If you only have an order number, set `orderIdType` to `order-number`.\n" }, { "info": { "name": "Check Order Cancellation Eligibility by Order Identifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderIdType/:orderIdValue/actions/check-cancel-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdType", "value": "order-id", "type": "path", "description": "The type of order identifier used to locate the order. \nSupported values: \n- `order-id` \n- `order-number` \n- `order-external-id`\n" }, { "name": "orderIdValue", "value": "ORDER0001", "type": "path", "description": "The value of the specified order identifier." }, { "name": "policyName", "value": "", "type": "query", "description": "The merchant-defined cancellation policy to use when evaluating eligibility. \nIf omitted, the default policy is applied.\n" }, { "name": "lineItemIds", "value": "", "type": "query", "description": "One or more line item IDs. \n- If specified, eligibility is checked only for the given line items. \n- If omitted, eligibility is checked for each item in the order.\n" } ] }, "docs": "Determines whether an order is eligible for cancellation. \n- Customers may initiate cancellations due to incorrect order placement. \n- Merchants may initiate cancellations due to product unavailability, pricing errors, payment failures, or shipping restrictions. \n\nYou can also specify `lineItemIds` to check cancellation eligibility for specific line items. \nIf not provided, eligibility is checked for each item in the order. \n\n**Note:** \n- Use this endpoint if you have the order ID, order n" }, { "info": { "name": "Cancel Order by Order ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/cancel", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "24-character system-generated order ID returned in the response of Create Order - `POST /orders` endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "When customers 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`.

" }, { "info": { "name": "Get Order Cancellation Eligibility by Order ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/check-cancel-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "24-character system-generated order ID returned in the response of Create Order - `POST /orders` endpoint." }, { "name": "policyName", "value": "", "type": "query", "description": "Merchant-defined cancellation policy. When omitted, the default policy is considered." }, { "name": "lineItemIds", "value": "", "type": "query", "description": "Line item IDs. If specified, gets eligibility of exchange for the given line items. If omitted, gets eligibility of exchange for each item in the order." } ] }, "docs": "Determines whether an order is eligible for cancellation. \n- Customers may initiate cancellation due to incorrect order placement. \n- Merchants may initiate cancellation due to product unavailability, pricing errors, \n payment failures, or shipping restrictions. \n\nThis endpoint checks cancellation eligibility using the **order ID**. \nYou can also specify `lineItemIds` to check eligibility for specific line items. \nIf omitted, eligibility is checked for each item in the order. \n\n**Note:** " } ] }, { "info": { "name": "Appeasements", "type": "folder" }, "items": [ { "info": { "name": "Create an Appeasement by Order Identifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderIdType/:orderIdValue/actions/create-appeasement", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdType", "value": "order-id", "type": "path", "description": "The type of order identifier used to locate the order. \nSupported values: \n- `order-id` \n- `order-number` \n- `order-external-id`\n" }, { "name": "orderIdValue", "value": "ORDER0001", "type": "path", "description": "The value of the specified order identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an appeasement (such as a partial refund or credit) when a customer is dissatisfied \nwith their shopping experience. This endpoint allows you to initiate an appeasement \nrequest by providing an order identifier.\n\n**Note:** \n- Use this endpoint if you have the order ID, order number, or external order ID. \n- If you only have an order number, you can still use this endpoint by setting `orderIdType` to `order-number`.\n" }, { "info": { "name": "Check Appeasement Eligibility by Order Identifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderIdType/:orderIdValue/actions/check-appeasement-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdType", "value": "order-id", "type": "path", "description": "The type of order identifier used to locate the order. \nSupported values: \n- `order-id` \n- `order-number` \n- `order-external-id`\n" }, { "name": "orderIdValue", "value": "ORDER0001", "type": "path", "description": "The value of the specified order identifier." } ] }, "docs": "Checks whether a given order is eligible for an appeasement (such as a partial refund or credit). \nThis endpoint evaluates eligibility based on the provided order identifier.\n\n**Note:** \n- Use this endpoint if you have the order ID, order number, or external order ID. \n- If you only have an order number, set `orderIdType` to `order-number`.\n" }, { "info": { "name": "Check Appeasement Eligibility by Order Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/check-appeasement-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "ORDER0000111", "type": "path", "description": "Merchant-defined order identifier" } ] }, "docs": "This endpoint checks for the appeasement eligibility of an order by order number." }, { "info": { "name": "Create Appeasement by Order Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/create-appeasement", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "123k4h123k", "type": "path", "description": "Merchant-defined order identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 do not have an order number, use the corresponding order ID-based endpoint - `POST /orders/{orderId}/actions/create-appeasement`

" }, { "info": { "name": "Check Appeasement Eligibility by Order ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/check-appeasement-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "ORDER0000111", "type": "path", "description": "The merchant-defined order identifier provided during the Create Order - `POST /orders` endpoint." } ] }, "docs": "This endpoint checks for the appeasement eligibility of an order by orderId." }, { "info": { "name": "Create Appeasement by Order ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/create-appeasement", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "24-character system-generated ID. It is returned in the response of Create Order - `POST /orders` endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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`.

" } ] }, { "info": { "name": "Credits", "type": "folder" }, "items": [ { "info": { "name": "Create Credits by Order Identifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderIdType/:orderIdValue/actions/create-credits", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdType", "value": "order-id", "type": "path", "description": "The type of order identifier used to locate the order. \nSupported values: \n- `order-id` \n- `order-number` \n- `order-external-id`\n" }, { "name": "orderIdValue", "value": "ORDER0001", "type": "path", "description": "The value of the specified order identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates credits for an order when you want to issue compensation to a customer. \nThis endpoint allows you to initiate a credit request using an order identifier.\n\n**Note:** \n- Use this endpoint if you have the order ID, order number, or external order ID. \n- If you only have an order number, set `orderIdType` to `order-number`.\n" }, { "info": { "name": "Check Credits Eligibility by Order Identifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderIdType/:orderIdValue/actions/check-credits-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdType", "value": "order-id", "type": "path", "description": "The type of order identifier used to locate the order. \nSupported values: \n- `order-id` \n- `order-number` \n- `order-external-id`\n" }, { "name": "orderIdValue", "value": "ORDER0001", "type": "path", "description": "The value of the specified order identifier." } ] }, "docs": "Checks whether an order is eligible for credits (for example, gift cards or store credits) \nin scenarios such as damaged products, late deliveries, or other qualifying \nconditions defined by your business policies. \n\nThis endpoint allows you to verify eligibility using an order identifier, helping \nbusinesses manage credits effectively and provide appropriate compensation to \ncustomers. \n\n**Note:** \n- Use this endpoint if you have the order ID, order number, or external order ID. \n- If you o" }, { "info": { "name": "Update Credit Status by Order Identifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderIdType/:orderIdValue/actions/update-credit-status", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdType", "value": "order-id", "type": "path", "description": "The type of order identifier used to locate the order. \nSupported values: \n- `order-id` \n- `order-number` \n- `order-external-id`\n" }, { "name": "orderIdValue", "value": "ORDER0001", "type": "path", "description": "The value of the specified order identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the status of credits associated with an order. \nThis endpoint can also be used to add notes or update additional \nattributes related to a credit. \n\n**Note:** \n- Use this endpoint if you have the order ID, order number, or external order ID. \n- If you only have an order number, set `orderIdType` to `order-number`.\n" }, { "info": { "name": "Check Credits Eligibility by Order Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/check-credits-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "ORDER000001", "type": "path", "description": "The merchant-defined order identifier provided by the Create Order - `POST /orders` endpoint." } ] }, "docs": "When processing refunds, credits such as a gift card may be offered to customers for various reasons such as damaged products, late 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.

" }, { "info": { "name": "Create Credits by Order Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/create-credits", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "ORDER0001", "type": "path", "description": "The merchant-defined order identifier provided during the Create Order - `POST /orders` endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The following endpoint is used to create credits using an order number." }, { "info": { "name": "Update Credit Status by Order Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/update-credit-status", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "ORDER0001", "type": "path", "description": "The merchant-defined order identifier provided during the Create Order - `POST /orders` endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "The update credit status endpoint is used to update the credits status, notes, and additional credit attributes." }, { "info": { "name": "Check Credits Eligibility by Order ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/check-credits-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "24-character system-generated order ID returned in the response of Create Order - `POST /orders` endpoint." } ] }, "docs": "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.

" }, { "info": { "name": "Create Credits by Order ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/create-credits", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "24-character system-generated order ID returned in the response of Create Order - `POST /orders` endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to create credits by order ID." }, { "info": { "name": "Update Credits by Order ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/update-credit-status", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "24-character system-generated order ID returned in the response of Create Order - `POST /orders` endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to update the credit status, as well as to add any associated notes and additional attributes." } ] }, { "info": { "name": "Returns", "type": "folder" }, "items": [ { "info": { "name": "Submit Return Request by Order Identifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderIdType/:orderIdValue/actions/submit-return-request", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdType", "value": "order-external-id", "type": "path", "description": "The type of order identifier used to locate the order. \nSupported values: \n- `order-number` \n- `order-external-id`\n" }, { "name": "orderIdValue", "value": "bef5680-u1245678", "type": "path", "description": "The value of the specified order identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submits a return request for an order once it has been determined that the \ncustomer's return request is eligible. \nThis endpoint processes the return request using the specified order identifier. \n\n**Note:** \n- Use this endpoint if you have the order number or external order ID. \n- If you only have an order number, set `orderIdType` to `order-number`. \n- If you only have an external order ID, set `orderIdType` to `order-external-id`.\n" }, { "info": { "name": "Check Order Exchange Eligibility by Order Identifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderIdType/:orderIdValue/actions/check-exchange-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdType", "value": "order-external-id", "type": "path", "description": "The type of order identifier used to locate the order. \nSupported values: \n- `order-number` \n- `order-external-id`\n" }, { "name": "orderIdValue", "value": "bef5680-u1245678", "type": "path", "description": "The value of the specified order identifier." }, { "name": "policyName", "value": "RETURNS_POLICY_1", "type": "query", "description": "The merchant-defined exchange policy to apply. \nIf omitted, the default policy is used.\n" }, { "name": "lineItemId", "value": "62f3dfc438bcab1951be0a19", "type": "query", "description": "A single line item ID. \n- If specified, eligibility is checked only for that item. \n- If omitted, eligibility is checked for each item in the order.\n" } ] }, "docs": "Determines whether an item or order is eligible for exchange. \nCustomers may request an exchange due to size, fit, color, or style preferences. \nThis endpoint verifies eligibility according to your defined business policies. \n\nYou can also specify a `lineItemId` to check exchange eligibility for a specific \nitem. If omitted, eligibility is checked for each item in the order. \n\n**Note:** \n- Use this endpoint if you have the order number or external order ID. \n- If you only have an order num" }, { "info": { "name": "Check Return Eligibility by Order Identifier", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderIdType/:orderIdValue/actions/check-return-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderIdType", "value": "order-external-id", "type": "path", "description": "The type of order identifier used to locate the order. \nSupported values: \n- `order-number` \n- `order-external-id`\n" }, { "name": "orderIdValue", "value": "bef5680-u1245678", "type": "path", "description": "The value of the specified order identifier." }, { "name": "policyName", "value": "RETURNS_POLICY_1", "type": "query", "description": "The merchant-defined return policy to apply. \nIf omitted, the default policy is used.\n" }, { "name": "lineItemId", "value": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569", "type": "query", "description": "A single line item ID. \n- If specified, eligibility is checked only for that item. \n- If omitted, eligibility is checked for each item in the order.\n" } ] }, "docs": "Determines whether one or more items in an order are eligible for return. \nCustomers may request a return because items did not meet expectations or \nthey simply changed their mind. \n\nThis endpoint verifies eligibility according to your defined return policies. \nYou can also specify a `lineItemId` to check return eligibility for a specific \nitem. If omitted, eligibility is checked for each item in the order. \n\n**Note:** \n- Use this endpoint if you have the order number or external order ID." }, { "info": { "name": "Get Order Exchange Eligibility by Order Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/check-exchange-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "Order-320000001", "type": "path", "description": "Merchant-defined order identifier" }, { "name": "policyName", "value": "RETURNS_POLICY_1", "type": "query", "description": "Merchant-defined exchange policy. When omitted, the default policy is considered." }, { "name": "lineItemId", "value": "62f3dfc438bcab1951be0a19", "type": "query", "description": "Line item ID. If specified, gets exchange eligibility of the given line item. If omitted, gets exchange eligibility of each item in the order." } ] }, "docs": "Determines whether an order or specific items within an order are eligible for exchange. \nCustomers may request an exchange due to size, fit, color, or style preferences. \nThis endpoint checks exchange eligibility using the **order number**. \n\nYou can also specify a `lineItemId` to check eligibility for a specific item. \nIf omitted, eligibility is checked for each item in the order. \n\n**Note:** \n- Use this endpoint only if you have the order number. \n- If you have an order ID instead, use" }, { "info": { "name": "Get Return Eligibility by Order Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/check-return-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "Order-320000001", "type": "path", "description": "Merchant-defined order identifier" }, { "name": "policyName", "value": "RETURNS_POLICY_1", "type": "query", "description": "Merchant-defined return policy. When omitted, the default policy is considered." }, { "name": "lineItemId", "value": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569", "type": "query", "description": "Line item ID. If specified, you'll get the return eligibility of the given line item ID. If omitted, you'll get the return eligibility of each item in the order." } ] }, "docs": "Determines whether one or more items in an order are eligible for return. \nCustomers may request a return if items do not meet expectations or if they \nhave simply changed their mind. \nThis endpoint checks return eligibility using the **order number**. \n\nYou can also specify a `lineItemId` to check eligibility for a specific item. \nIf omitted, eligibility is checked for each item in the order. \n\n**Note:** \n- Use this endpoint only if you have the order number. \n- If you have an order ID i" }, { "info": { "name": "Order Return by Order Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/submit-return-request", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "Order-20000001", "type": "path", "description": "Merchant-defined order identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "When the customers 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`.

" }, { "info": { "name": "Get Order Exchange Eligibility by Order ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/check-exchange-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "24-character system-generated order ID returned in the response of Create Order - `POST /orders` endpoint." }, { "name": "policyName", "value": "RETURNS_POLICY_1", "type": "query", "description": "Merchant-defined exchange policy. When omitted, the default policy is considered." }, { "name": "lineItemId", "value": "62f3dfc438bcab1951be0a19", "type": "query", "description": "Line item ID. If specified, gets exchange eligibility of the given line item ID. If omitted, gets exchange eligibility of each item in the order." } ] }, "docs": "Customers may want exchange an item because of size, color, or style preferences. Before processing exchange, its 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/{order" }, { "info": { "name": "Get Eligibility of Returns for Items in an Order by Order ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/check-return-eligibility", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "24-character system-generated order ID returned in the response of Create Order - `POST /orders` endpoint." }, { "name": "policyName", "value": "RETURNS_POLICY_1", "type": "query", "description": "Merchant-defined return policy. When omitted, the default policy is considered." }, { "name": "lineItemId", "value": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569", "type": "query", "description": "Line item ID. If specified, gets the return eligibility of the given line item ID. If omitted, gets the return eligibility of each item in the order." } ] }, "docs": "Determines whether one or more items in an order are eligible for return. \nCustomers may request a return if items do not meet expectations or if they \nhave simply changed their mind. \n\nThis endpoint checks return eligibility using the **order ID**. \nYou can also specify a `lineItemId` to check eligibility for a specific item. \nIf omitted, eligibility is checked for each item in the order. \n\n**Note:** \n- Use this endpoint only if you have the order ID. \n- If you have an order number inste" }, { "info": { "name": "Order Return by Order ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/submit-return-request", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "", "type": "path", "description": "24-character system-generated order ID returned in the response of Create Order - `POST /orders` endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "When customers 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`.

" } ] }, { "info": { "name": "Frauds", "type": "folder" }, "items": [ { "info": { "name": "Cancel Fraud Order by Order Number", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/fraud-cancel", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "123k4h123k", "type": "path", "description": "Merchant-defined order identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "If an order is suspected to be fraudulent, it is immediately placed on hold for verification. After verification, if its confirmed as fraudulent, this endpoint is used to cancel the order by order number.

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

" }, { "info": { "name": "Release Fraud Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/fraud-release", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "123k4h123k", "type": "path", "description": "Merchant-defined order identifier" } ] }, "docs": "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 do not have an order number, use the corresponding order ID-based endpoint - `POST /orders/{orderId}/actions/fraud-release`.

" }, { "info": { "name": "Cancel Fraud Order by Order ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/fraud-cancel", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "24-character system-generated order ID returned in the response of Create Order - `POST /orders` endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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`

" }, { "info": { "name": "Release Fraud Order by Order ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/fraud-release", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "5349b4ddd2781d08c09890f4", "type": "path", "description": "24-character system-generated order ID returned in the response of Create Order - `POST /orders` endpoint" } ] }, "docs": "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 do not have order ID, use the corresponding order number-based endpoint - `POST /orders/order-number/{orderNumber}/actions/fraud-release`.

" } ] }, { "info": { "name": "Tracking", "type": "folder" }, "items": [ { "info": { "name": "Get Acknowledgement for Package Tracking by Order Number", "type": "http" }, "http": { "method": "PUT", "url": "https://api.fabric.inc/v3/orders/order-number/:orderNumber/actions/package-tracking-acknowledge", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderNumber", "value": "309019176", "type": "path", "description": "Merchant-defined order identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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`.

" }, { "info": { "name": "Get Package Tracking Acknowledgement by Order ID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.fabric.inc/v3/orders/:orderId/actions/package-tracking-acknowledge", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "12" }, { "name": "x-fabric-request-id", "value": "263e731c-45c8-11ed-b878-0242ac120002" } ], "params": [ { "name": "orderId", "value": "as4refar4e309019176", "type": "path", "description": "24-character system-generated ID. It is returned in the response of Create Order - `POST /orders` endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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`.

" } ] } ], "bundled": true }