Skip to main content

Update Custom Discount For Cart Item

PUT 

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

Use this endpoint to update a custom discount in your cart item.

Request

Path Parameters

    cartID stringrequired

    Specifies the ID for the cart.

    cartitemID stringrequired

    Specifies the ID for the cart item.

    customdiscountID stringrequired

    Specifies the ID for the custom discount to be updated.

Body

    data object
    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

Response Headers
    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.

    Loading...