v1

latestOpenAPI 3.0.02026-07-267331140.7 KB
Physical Card Order

Attach a coupon to a Physical Card Order

This endpoint associates a provided coupon code with an existing card order by its orderId. Use the GPDOCS coupon code to get the card for free.

post/api/v1/order/{orderId}/attach-coupon

Path parameters

orderIdstring required

The unique identifier of the card order to which the coupon will be attached.

Request body

couponCodestring required

The coupon code to be applied to the order.

Example request

{
  "couponCode": "DISCOUNT2023"
}

Response

Coupon successfully attached to the card order.

couponCodestring

The coupon code that was applied to the order.

Example response

{
  "couponCode": "DISCOUNT2023"
}