{ "opencollection": "1.0.0", "info": { "name": "Cart Actions Endpoints Promotions API", "version": "3.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Promotions", "type": "folder" }, "items": [ { "info": { "name": "Get All Promotions", "type": "http" }, "http": { "method": "GET", "url": "https://api.fabric.inc/v3/promotions", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "" }, { "name": "x-client-id", "value": "copilot" }, { "name": "x-fabric-request-id", "value": "" } ], "params": [ { "name": "size", "value": "", "type": "query", "description": "The maximum number of records per page." }, { "name": "offset", "value": "", "type": "query", "description": "The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30." }, { "name": "sort", "value": "", "type": "query", "description": "The criteria to sort the results. Use the format {sort order}{field name}, where `-` refers to a descending order and `+` refers to an ascending order." }, { "name": "search", "value": "", "type": "query", "description": "The keyword to filter the promotions." } ] }, "docs": "Retrieves a paginated list of all promotions." }, { "info": { "name": "Create Promotion", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/promotions", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "" }, { "name": "x-client-id", "value": "copilot" }, { "name": "x-fabric-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get a Specific Promotion", "type": "http" }, "http": { "method": "GET", "url": "https://api.fabric.inc/v3/promotions/:promotionId", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "" }, { "name": "x-client-id", "value": "copilot" }, { "name": "x-fabric-request-id", "value": "" } ], "params": [ { "name": "promotionId", "value": "", "type": "path", "description": "The promotion ID generated when using the [create promotion](/v3/api-reference/offers/promotions/create-promotion) endpoint." } ] }, "docs": "Retrieves a specific promotion using the corresponding `promotionId`." }, { "info": { "name": "Update a Specific Promotion", "type": "http" }, "http": { "method": "PUT", "url": "https://api.fabric.inc/v3/promotions/:promotionId", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "" }, { "name": "x-client-id", "value": "copilot" }, { "name": "x-fabric-request-id", "value": "" } ], "params": [ { "name": "promotionId", "value": "", "type": "path", "description": "The promotion ID generated when using the [create promotion](/v3/api-reference/offers/promotions/create-promotion) endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific promotion using the corresponding `promotionId`." }, { "info": { "name": "Delete a Specific Promotion", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.fabric.inc/v3/promotions/:promotionId", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "" }, { "name": "x-client-id", "value": "copilot" }, { "name": "x-fabric-request-id", "value": "" } ], "params": [ { "name": "promotionId", "value": "61dfc146bf98990009b7091c", "type": "path", "description": "The promotion ID generated when using the [create promotion](/v3/api-reference/offers/promotions/create-promotion) endpoint." } ] }, "docs": "Delete a specific promotion using the corresponding `promotionId`." }, { "info": { "name": "Enable or Disable a Promotion", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/promotions/:promotionId/actions/toggle", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "" }, { "name": "x-client-id", "value": "copilot" }, { "name": "x-fabric-request-id", "value": "" } ], "params": [ { "name": "promotionId", "value": "", "type": "path", "description": "The promotion ID generated when using the [create promotion](/v3/api-reference/offers/promotions/create-promotion) endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "End a Promotion", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/promotions/:promotionId/actions/end", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "" }, { "name": "x-client-id", "value": "copilot" }, { "name": "x-fabric-request-id", "value": "" } ], "params": [ { "name": "promotionId", "value": "", "type": "path", "description": "The promotion ID generated when using the [create promotion](/v3/api-reference/offers/promotions/create-promotion) endpoint." } ] }, "docs": "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." }, { "info": { "name": "Search for Promotions", "type": "http" }, "http": { "method": "POST", "url": "https://api.fabric.inc/v3/promotions/search", "headers": [ { "name": "x-fabric-tenant-id", "value": "5f328bf0b5f328bf0b5f328b" }, { "name": "x-fabric-channel-id", "value": "" }, { "name": "x-client-id", "value": "copilot" }, { "name": "x-fabric-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use this endpoint to search for promotions based on specified filter conditions." } ] } ], "bundled": true }