Get a subscription discount

curl --request GET \
  --url https://prod01.copilot.fabric.inc/data-subscription/v1/subscriptionDiscount/{offerId} \
  --header 'Authorization: Bearer <token>'

{
  "responseStatus": "OK",
  "message": "Request processed successfully",
  "data": {
    "id": "62d9196aeec12800095633f2",
    "status": "ACTIVE",
    "offerCode": "SUB-D45DD7",
    "validity": {
      "startDate": "2022-07-21T13:14:51.474Z",
      "endDate": "2022-07-21T13:14:51.474Z",
      "applyOnOrders": [
        2,
        3
      ]
    },
    "message": "Offer terms and conditions",
    "discount": {
      "amount": 10
    },
    "skus": [
      "MOBO-X570"
    ],
    "categories": [
      "holiday-best-sellers"
    ],
    "frequency": {
      "shippingFrequency": 1,
      "shippingFrequencyType": "daily",
      "billingFrequency": 1,
      "billingFrequencyType": "daily"
    },
    "itemQuantity": 1,
    "channel": "WEBSITE",
    "target": "PDP",
    "customerSegment": [
      "employee"
    ],
    "isDeleted": false,
    "DeletedAt": "2019-01-01T00:00:00.000Z",
    "createdAt": "2021-10-12T21:35:05.756Z",
    "updatedAt": "2021-10-14T05:40:55.997Z"
  }
}

GET

subscriptionDiscount

{offerId}

Get a subscription discount

curl --request GET \
  --url https://prod01.copilot.fabric.inc/data-subscription/v1/subscriptionDiscount/{offerId} \
  --header 'Authorization: Bearer <token>'

{
  "responseStatus": "OK",
  "message": "Request processed successfully",
  "data": {
    "id": "62d9196aeec12800095633f2",
    "status": "ACTIVE",
    "offerCode": "SUB-D45DD7",
    "validity": {
      "startDate": "2022-07-21T13:14:51.474Z",
      "endDate": "2022-07-21T13:14:51.474Z",
      "applyOnOrders": [
        2,
        3
      ]
    },
    "message": "Offer terms and conditions",
    "discount": {
      "amount": 10
    },
    "skus": [
      "MOBO-X570"
    ],
    "categories": [
      "holiday-best-sellers"
    ],
    "frequency": {
      "shippingFrequency": 1,
      "shippingFrequencyType": "daily",
      "billingFrequency": 1,
      "billingFrequencyType": "daily"
    },
    "itemQuantity": 1,
    "channel": "WEBSITE",
    "target": "PDP",
    "customerSegment": [
      "employee"
    ],
    "isDeleted": false,
    "DeletedAt": "2019-01-01T00:00:00.000Z",
    "createdAt": "2021-10-12T21:35:05.756Z",
    "updatedAt": "2021-10-14T05:40:55.997Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

offerId

string

required

Offer code

Example:

"SUB-D45DD7"

Response

Request processed successfully

Single discount by offerCode

responseStatus

string

Brief response status

Example:

"OK"

message

string

Full response message

Example:

"Request processed successfully"

data

object

Discount details

Show child attributes

data.id

string

Discount ID

Example:

"62d9196aeec12800095633f2"

data.status

enum<string>

Discount status

Available options:

ACTIVE,

INACTIVE

Example:

"ACTIVE"

data.offerCode

string

Offer code

Example:

"SUB-D45DD7"

data.validity

object

Dates during which discount is valid, and orders to which discount applies

Show child attributes

data.validity.startDate

string

Validity start date

Example:

"2022-07-21T13:14:51.474Z"

data.validity.endDate

string

Validity end date

Example:

"2022-07-21T13:14:51.474Z"

data.validity.applyOnOrders

integer[]

Orders to which discount applies

Order numbers to which discount applies

Example:

[2, 3]

data.message

string

Merchant discount message

Example:

"Offer terms and conditions"

data.discount

object

Discount detail

Show child attributes

data.discount.amount

number

Discount amount

Example:

10

data.skus

string[]

SKUs

SKU

data.categories

string[]

Product categories

Product category

data.frequency

object

Shipping frequency details

Show child attributes

data.frequency.shippingFrequency

integer

Shipping frequency

Example:

1

data.frequency.shippingFrequencyType

enum<string>

Shipping frequency period

Available options:

daily,

weekly,

monthly,

yearly

Example:

"daily"

data.frequency.billingFrequency

integer

Billing frequency

Example:

1

data.frequency.billingFrequencyType

enum<string>

Billing frequency period

Available options:

daily,

weekly,

monthly,

yearly

Example:

"daily"

data.itemQuantity

integer

Number of items

Example:

1

data.channel

enum<string>

Channel

Available options:

WEBSITE,

POS

Example:

"WEBSITE"

data.target

enum<string>

Discount target

Available options:

PDP,

CART,

QUICK VIEW,

SUBSCRIPTION MANAGEMENT PORTAL

Example:

"PDP"

data.customerSegment

string[]

Customer segments

Customer segment

data.isDeleted

boolean

true: Customer is deleted
false: Customer is not deleted

Example:

false

data.DeletedAt

string

If isDeleted=true, time at which the customer was deleted
If isDeleted=false, NULL

Example:

"2019-01-01T00:00:00.000Z"

data.createdAt

string

Time customer was created

Example:

"2021-10-12T21:35:05.756Z"

data.updatedAt

string

Most recent time customer was updated

Example:

"2021-10-14T05:40:55.997Z"

Deactivate a subscription discount Update a subscription discount

⌘I

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Get a subscription discount

Authorizations

Path Parameters

Response