Create

Maakt een nieuwe bestelling aan en eventueel een uitnodiging, en stuurt de aangemaakte bestelling en uitnodiging terug.

Request

Headers

De "Authorization" header voor deze API methode bevat een <access_token> plaatshouder. Vervang deze door de waarde van een actueel toegangstoken.

Name

Value

Authorization

Bearer <access_token>

URL

Body

Deze API-methode accepteert een JSON body in het verzoek. Het top-level JSON object moet een "Order" object zijn zoals beschreven in de volgende sectie.

Order

Property

Allowed Values

Required

External_id

(a unique non-empty string, max 250 characters)

Yes

Customer

(A 'Customer' object)

Yes

invitation

(an 'Invitation' object)

No

products

(An array of 'product' projects)

No

filtercode

(An optimal string, max 250 characters)

No

Customer

name

Allowed Values

Required

email

(A valid email address, max 250 characters)

Yes

fullname

(A non-empty string, max 250 characters)

No

Invitation

De "delay" en "reminder" eigenschappen vertegenwoordigen een specifieke datum en tijd waarop de uitnodigingsmail en de herinneringsmail voor de uitnodiging moet worden verzonden. De "reminder", indien gegeven, moet ten minste 24 uur na de "delay" liggen.

Name

Allowed values

Required

delay

(an invitationDelay object)

Yes

reminder

(an invitationDelay object

No

InvitationDelay

Name

Allowed Values

Required

unit

"minutes","hours","days","weekdays"

Yes

amount

(A non-negative integer)

Yes

Product

Name

Allowed values

Required

external_id

(A non-empty string, max 250 characters)

Yes

name

(A non-empty string, max 250 characters)

Yes

url

(A valid url, max 2000 characters)

Yes

sku

(A non-empty string, max 250 characters)

No

gtin

(A valid GTIN-13 code)

No

image_url

(A valid url, max 2000 characters)

No

Voorbeeld

{
"external_id": "08b747cb-e20a-4644-9900-7db115e2f249",
"customer": {
"email": "appleseed@example.com",
"fullname": "John Appleseed"
},
"products": [{
"external_id": "c17b8994-7a31-4dda-b710-a1bb5cd97e55",
"sku": "rd001",
"gtin": "0075678164124",
"name": "Red Delicious",
"url": "https://www.example.com/producs/red-delicious",
"image_url": "https://www.example.com/images/red-delicious.jpeg"
}],
"invitation": {
"delay": {
"unit": "days",
"amount": 0
},
"reminder": {
"unit": "days",
"amount": 7
}
},
"filtercode": "filtercode1234"
}

Response

Headers

Name

Value

Status code

201

Status Message

Created

Voorbeeld

{
"success": true
}


Heeft u het antwoord gevonden?