API Reference
  1. WSHOP API
  2. Gift Cards

Retrieve gift cards

post
https://{instance}.wshop.cloud/api/v1/giftcards/get

Exactly one search criterion is required: orderId, giftcardCode, email, or the created_from + created_to pair. orderId, giftcardCode and email match as a prefix.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Order in which the gift card was bought or used

string

The gift card code

string

Email of the client who bought or used the gift card. Must belong to an existing client.

string

Start of the creation date range, to use with created_to. Format YYYY-MM-DD HH:MM:SS.

string

End of the creation date range, to use with created_from (must be after it). Format YYYY-MM-DD HH:MM:SS.

integer
≥ 1

Site ID. Defaults to the main site.

Responses

Updated 6 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?