Create a promotion code | Solvimon

curl -X POST https://test.api.solvimon.com/v1/promotion-codes \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "code_format": "string",
  "code": "string",
  "coupon_id": "string"
}'

{
  "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"
}

Requires the PROMOTION_CODE.CREATE 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

Request

This endpoint expects an object.

code_formatstringRequired

codestringRequired

coupon_idstringRequired

statusenum or nullOptional

Allowed values:

limited_toobjectOptional

start_atstring or nullOptional

end_atstring or nullOptional

maximum_redemptionsinteger or nullOptional

Response

Created

codestring

coupon_idstring

object_typestring or nullRead-only

idstring or nullRead-only

statusenum or null

Allowed values:

limited_toobject

start_atstring or null

end_atstring or null

maximum_redemptionsinteger or null

number_of_redemptionsinteger or nullRead-only

created_atstring or nullRead-only

updated_atstring or nullRead-only

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

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

Authentication

Path parameters

Headers

Request

Response

Errors