Get a promotion code

GET

/v:version/promotion-codes/:resourceIdOrReference

GET

/v:version/promotion-codes/:resourceIdOrReference

$ curl https://test.api.solvimon.com/v1/promotion-codes/ \
>      -H "X-API-KEY: <apiKey>"

1 {
2   "object_type": "string",
3   "id": "string",
4   "code": "string",
5   "coupon_id": "string",
6   "status": "DRAFT",
7   "limited_to": {
8     "customer_ids": [
9       "string"
10     ],
11     "customers": [
12       {
13         "object_type": "string",
14         "id": "string",
15         "created_at": "string",
16         "parent_customer_id": "string",
17         "parent_customer_ids": [
18           "string"
19         ],
20         "reference": "string",
21         "status": "DRAFT",
22         "timezone": "string",
23         "type": "ORGANIZATION",
24         "email": "string",
25         "notification_preferences": [
26           {
27             "type": "INVOICE",
28             "channels": [
29               {
30                 "type": "EMAIL",
31                 "enabled": true
32               }
33             ]
34           }
35         ],
36         "locale": "string",
37         "individual": {
38           "name": {
39             "first_name": "string",
40             "last_name": "string",
41             "infix": "string"
42           },
43           "residential_address": {
44             "line1": "string",
45             "line2": "string",
46             "city": "string",
47             "postal_code": "string",
48             "state": "string",
49             "country": "AD"
50           }
51         },
52         "organization": {
53           "legal_name": "string",
54           "tax_id": "string",
55           "tax_ids": [
56             {
57               "id": "string",
58               "type": "GENERIC_TAX_ID",
59               "display_name": "string",
60               "tax_id_validation_result": {
61                 "id": "string",
62                 "validation_date": "string",
63                 "source": "string",
64                 "valid": "VALID",
65                 "message": "string"
66               }
67             }
68           ],
69           "registration_number": "string",
70           "tax_exempt": true,
71           "tax_exempt_note": "string",
72           "registered_address": {
73             "line1": "string",
74             "line2": "string",
75             "city": "string",
76             "postal_code": "string",
77             "state": "string",
78             "country": "AD"
79           },
80           "tax_registrations": [
81             {
82               "id": "string",
83               "description": "string",
84               "tax_id": "string",
85               "tax_ids": [
86                 {
87                   "id": "string",
88                   "type": "GENERIC_TAX_ID",
89                   "display_name": "string",
90                   "tax_id_validation_result": {
91                     "id": "string",
92                     "validation_date": "string",
93                     "source": "string",
94                     "valid": "VALID",
95                     "message": "string"
96                   }
97                 }
98               ],
99               "registration_number": "string",
100               "registered_address": {
101                 "line1": "string",
102                 "line2": "string",
103                 "city": "string",
104                 "postal_code": "string",
105                 "state": "string",
106                 "country": "AD"
107               }
108             }
109           ]
110         },
111         "custom_fields": [
112           {
113             "id": "string",
114             "reference": "string",
115             "value": "string",
116             "values": [
117               "string"
118             ],
119             "integration_details": {
120               "id": "string",
121               "reference": "string",
122               "payment_gateway_variant": "ADYEN",
123               "adyen": {
124                 "recurring_detail_reference": "string"
125               },
126               "stripe": {
127                 "payment_method_id": "string"
128               }
129             },
130             "integration_id": "string"
131           }
132         ],
133         "pricing_plan_subscription_selector": {
134           "data": [
135             {
136               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
137               "value": "string"
138             }
139           ],
140           "rules": [
141             {
142               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
143               "type": "EQUALS"
144             }
145           ],
146           "filters": [
147             {
148               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
149               "type": "EQUALS",
150               "value": "string"
151             }
152           ],
153           "fallback": "LATEST"
154         },
155         "linked_integrations": [
156           {
157             "id": "string",
158             "link_details": [
159               {
160                 "url": "string",
161                 "custom_field_name": "string"
162               }
163             ]
164           }
165         ],
166         "roles": [
167           "DEFAULT"
168         ],
169         "seller_details": {
170           "default_billing_entity_id": "string"
171         },
172         "processing_only": true
173       }
174     ]
175   },
176   "start_at": "string",
177   "end_at": "string",
178   "maximum_redemptions": 1,
179   "number_of_redemptions": 1,
180   "created_at": "string",
181   "updated_at": "string"
182 }

Requires the PROMOTION_CODE.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdOrReferencestringRequiredDefaults to

The ID or reference of the resource.

Query parameters

expand[]list of stringsOptional

The id fields of the resources that are going to be expanded.

Response

object_typestring or nullOptionalRead-only

idstring or nullOptionalRead-only

codestringOptional

coupon_idstringOptional

statusenum or nullOptional

limited_toobjectOptional

start_atstring or nullOptional

end_atstring or nullOptional

maximum_redemptionsinteger or nullOptional

number_of_redemptionsinteger or nullOptionalRead-only

created_atstring or nullOptionalRead-only

updated_atstring or nullOptionalRead-only

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors