Add Custom Discount To Cart Item

POST 
/v2/carts/:cartID/items/:cartitemID/custom-discounts

Use this endpoint to add a custom discount to cart item.

Request

Path Parameters

cartID stringrequired

Specifies the ID for the cart.

cartitemID stringrequired

Specifies the unique identifier for the cart item.

application/json

Body

amount numberrequired

Specifies an amount to be applied for the custom discount. It must be less than zero.

description stringrequired

Specifies a description for the custom discount.

discount_code stringrequired

Specifies the discount code used for the custom discount.

discount_engine stringrequired

Specifies from where the custom discount is applied. For example, Talon.one.

external_id stringrequired

Specifies an external id for the custom discount.

type stringrequired

Specifies the type of the resource. Always custom_discount.

Responses

200

Response Headers

application/json

Schema

Schema

data object

amount object

amount number

Specifies an amount to be applied for the custom discount. It must be less than zero.

currency string

The currency set for the custom discount.

formatted string

The formatted value for the custom discount.

description string

Specifies a description for the custom discount.

discount_code string

Specifies the discount code used for the custom discount.

discount_engine string

Specifies from where the custom discount is applied. For example, Talon.one.

external_id string

Specifies an external id for the custom discount.

type string

Specifies the type of the resource. Always custom_discount.

id uuid

Specifies the UUID of the custom discount.

Example (from schema)

{
  "data": {
    "amount": {
      "amount": 0,
      "currency": "string",
      "formatted": "string"
    },
    "description": "string",
    "discount_code": "string",
    "discount_engine": "string",
    "external_id": "string",
    "type": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

401

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 401,
    "title": "Unauthorized"
  }
}

Loading...