Rest API

Rest api for quick Request For Quot

Get List Gift Card By Quote Id

Endpoint: /V1/carts/:quoteId/giftCards

Method: GET

Params:

  • quoteId

Response Data:

{
  "gift_cards": [
    "string"
  ],
  "gift_cards_amount": 0,
  "base_gift_cards_amount": 0,
  "gift_cards_amount_used": 0,
  "base_gift_cards_amount_used": 0,
  "extension_attributes": {}
}

Edit Gift Card by quoteId

Endpoint: /V1/carts/:cartId/giftCards

Method: PUT

Params:

  • cartId

  • body:

    {
      "giftCardAccountData": {
        "gift_cards": [
          "string"
        ],
        "gift_cards_amount": 0,
        "base_gift_cards_amount": 0,
        "gift_cards_amount_used": 0,
        "base_gift_cards_amount_used": 0,
        "extension_attributes": {}
      }
    }

Response Data:

true

Delete Gift Card By Quote id

Endpoint: /V1/carts/:cartId/giftCards/:giftCardCode

Method: DELETE

Params:

  • giftCardCode

  • cartId

Response Data:

Guest Delete Gift Card

Endpoint: /V1/carts/guest-carts/:cartId/giftCards/:giftCardCode

Method: DELETE

Params:

  • cartId

  • giftCardCode

Response Data:

true

Customer Delete Gift Card

Endpoint: /V1/carts/mine/giftCards/:giftCardCode

Method: DELETE

Params:

  • giftCardCode

Response Data:

true

Customer Create Gift Card

Endpoint: /V1/carts/mine/giftCards

Method: POST

Params:

{
  "giftCardAccountData": {
    "gift_cards": [
      "string"
    ],
    "gift_cards_amount": 0,
    "base_gift_cards_amount": 0,
    "gift_cards_amount_used": 0,
    "base_gift_cards_amount_used": 0,
    "extension_attributes": {}
  }
}

Response Data:

true

Guest create Gift Card

Endpoint: /V1/carts/guest-carts/:cartId/giftCards

Method: POST

Params:

  • cartId

  • body:

    {
      "giftCardAccountData": {
        "gift_cards": [
          "string"
        ],
        "gift_cards_amount": 0,
        "base_gift_cards_amount": 0,
        "gift_cards_amount_used": 0,
        "base_gift_cards_amount_used": 0,
        "extension_attributes": {}
      }
    }

Response Data:

true

Check Gift Card For Guest

Endpoint: /V1/carts/guest-carts/:cartId/checkGiftCard/:giftCardCode

Method: GET

Params:

  • cartId

  • giftCardCode

Response Data:

0

Endpoint: /V1/carts/mine/checkGiftCard/:giftCardCode

Method: GET

Params:

  • giftCardCode

Response Data:

0

Last updated