Get promotion codes | Solvimon

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

{
  "data": [
    {
      "code": "string",
      "coupon_id": "string",
      "object_type": "string",
      "id": "string",
      "status": "DRAFT",
      "limited_to": {
        "customer_ids": [
          "string"
        ],
        "customers": [
          {
            "reference": "string",
            "type": "ORGANIZATION",
            "email": "string",
            "roles": [
              "DEFAULT"
            ],
            "object_type": "string",
            "id": "string",
            "created_at": "string",
            "parent_customer_id": "string",
            "parent_customer_ids": [
              "string"
            ],
            "status": "DRAFT",
            "timezone": "string",
            "notification_preferences": [
              {
                "type": "INVOICE",
                "channels": [
                  {
                    "type": "EMAIL",
                    "enabled": true
                  }
                ]
              }
            ],
            "locale": "string",
            "individual": {
              "name": {
                "first_name": "string",
                "last_name": "string",
                "infix": "string"
              },
              "residential_address": {
                "line1": "string",
                "line2": "string",
                "city": "string",
                "postal_code": "string",
                "state": "string",
                "country": "AD"
              }
            },
            "organization": {
              "legal_name": "string",
              "tax_id": "string",
              "tax_ids": [
                {
                  "id": "string",
                  "type": "GENERIC_TAX_ID",
                  "tax_id_validation_result": {
                    "id": "string",
                    "validation_date": "string",
                    "source": "string",
                    "valid": "VALID",
                    "message": "string"
                  }
                }
              ],
              "registration_number": "string",
              "tax_exempt": true,
              "tax_exempt_note": "string",
              "registered_address": {
                "line1": "string",
                "line2": "string",
                "city": "string",
                "postal_code": "string",
                "state": "string",
                "country": "AD"
              },
              "tax_registrations": [
                {
                  "id": "string",
                  "description": "string",
                  "tax_id": "string",
                  "tax_ids": [
                    {
                      "id": "string",
                      "type": "GENERIC_TAX_ID",
                      "tax_id_validation_result": {
                        "id": "string",
                        "validation_date": "string",
                        "source": "string",
                        "valid": "VALID",
                        "message": "string"
                      }
                    }
                  ],
                  "registration_number": "string",
                  "registered_address": {
                    "line1": "string",
                    "line2": "string",
                    "city": "string",
                    "postal_code": "string",
                    "state": "string",
                    "country": "AD"
                  }
                }
              ]
            },
            "custom_fields": [
              {
                "id": "string",
                "reference": "string",
                "value": "string",
                "values": [
                  "string"
                ],
                "integration_details": {
                  "payment_gateway_variant": "ADYEN",
                  "id": "string",
                  "reference": "string",
                  "adyen": {
                    "recurring_detail_reference": "string"
                  },
                  "stripe": {
                    "payment_method_id": "string"
                  }
                }
              }
            ],
            "processing_only": true,
            "pricing_plan_subscription_selector": {
              "data": [
                {
                  "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
                  "value": "string"
                }
              ],
              "rules": [
                {
                  "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
                  "type": "EQUALS"
                }
              ],
              "filters": [
                {
                  "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
                  "type": "EQUALS",
                  "value": "string"
                }
              ],
              "fallback": "LATEST"
            },
            "linked_integrations": [
              {
                "id": "string",
                "link_details": [
                  {
                    "url": "string",
                    "custom_field_name": "string"
                  }
                ]
              }
            ]
          }
        ]
      },
      "start_at": "string",
      "end_at": "string",
      "maximum_redemptions": 1,
      "number_of_redemptions": 1,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "links": {
    "first": "string",
    "previous": "string",
    "current": "string",
    "next": "string"
  },
  "limit": 1,
  "page": 1,
  "total_number_of_pages": 1
}

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

Query parameters

coupon_idstringOptional

Filter by coupon id.

statuses[]list of stringsOptional

Filter by promotion code status.

expand[]list of stringsOptional

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

limitintegerOptional

The amount of records shown in the list.

pageintegerOptional

The page which is going to be shown.

order_bystringOptional

The parameter by which the response is ordered.

order_directionstringOptional

The order direction by which the response is ordered.

Response

datalist of objects

linksobject

limitinteger or null

pageinteger or null

total_number_of_pagesinteger or nullDeprecated

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

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

Authentication

Path parameters

Headers

Query parameters

Response

Errors