Update a subscription discount

Update a subscription discount for a specified offer (specified by offer ID)

PUT /v1/subscriptionDiscount/{offerId}

Update a subscription discount

cURL

curl --request PUT \
  --url https://prod01.copilot.fabric.inc/data-subscription/v1/subscriptionDiscount/{offerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "discount": {
    "amount": 10
  },
  "message": "Offer terms and conditions",
  "skus": [
    "MOBO-X570"
  ],
  "categories": [
    "holiday-best-sellers"
  ],
  "frequency": {
    "shippingFrequency": 1,
    "shippingFrequencyType": "daily",
    "billingFrequency": 1,
    "billingFrequencyType": "daily"
  },
  "itemQuantity": 1,
  "channel": "WEBSITE",
  "target": "PDP"
}
'

200

{
  "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 ID General object ID

Example:

"606f01f441b8fc0008529916"

Body

application/json

Details used to update discount

Details used to update discount

discount · object

Discount detail

Show child attributes

message · string

Merchant discount message

Example:

"Offer terms and conditions"

skus · string[]

SKUs

SKU

categories · string[]

Product categories

Product category

frequency · object

Shipping frequency details

Show child attributes

itemQuantity · integer

Number of items

Example:

1

channel · enum<string>

Channel

Available options: WEBSITE, POS

Example:

"WEBSITE"

target · enum<string>

Discount target

Available options: PDP, CART, QUICK VIEW, SUBSCRIPTION MANAGEMENT PORTAL

Example:

"PDP"

Response

200

application/json

Request processed successfully

Discount details after update

responseStatus · string

Brief response status

Example:

"OK"

message · string

Full response message

Example:

"Request processed successfully"

data · object

Discount details

Show child attributes