Skip to content
Navigation

Names a coupon on a cart, or takes it off with null.

PUT
https://api.sherpo.io/customer/v1/stores/{store}/checkouts/{checkout}/coupon

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

  • checkout
    string
    required
    minLength: 1

Request body JSON required

  • code
    required

    A discount's code, or its id as an affiliate link carries it.

    One of the following:

    • string
    • null

Returns

200

Names a coupon on a cart, or takes it off with null.

JSON
  • status
    string
    required
  • order
    required

    One of the following:

    • object
    • null
  • under_minimum
    required

    One of the following:

    • object
    • null
  • card_required
    required

    One of the following:

    • object
    • null
  • items
    array of
    object
    required
    • product
      required

      One of the following:

      • object
      • null
    • autorenew
      required

      One of the following:

      • boolean
      • null
    • first_charge_at
      required

      One of the following:

      • string
      • null
    • refund_policy
      required

      One of the following:

      • string
      • null
    • refund_until
      required

      One of the following:

      • string
      • null
    • id
      string
      required
    • product_id
      string
      required
    • price_id
      string
      required
    • quantity
      number
      required
    • amount
      number
      required
    • discount
      number
      required
    • discount_id
      required

      One of the following:

      • string
      • null
    • total
      number
      required
    • mode
      string
      required
    • display_name
      required

      One of the following:

      • string
      • null
    • message
      required

      One of the following:

      • string
      • null
    • guests
      array of
      object
      required
      • email
        string
        required
      • name
        required

        One of the following:

        • string
        • null
  • totals
    object
    required
    • amount
      number
      required
    • discount
      number
      required
    • total
      number
      required
  • id
    string
    required
  • currency
    string
    required
  • exponent
    required

    One of the following:

    • number
    • null
  • coupon
    required

    One of the following:

    • string
    • null
  • refund_waiver
    required

    One of the following:

    • object
    • null
  • expires_at
    required

    One of the following:

    • string
    • null
  • created_at
    required

    One of the following:

    • string
    • null
  • updated_at
    required

    One of the following:

    • string
    • null
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close