Create a new recurrent order

This method creates a new recurrent pickup order based on your internal order number.

On the demo API instance you can use special values for the field relatedNotes to trigger behaviors:

  • $schedule-SSS: The API will simulate that the order articles are ready for input SSS seconds after creation.

If you provide an invalid number, the order will be created but no demo behavior will be triggered.

Example:

  • schedule order after 6 seconds after creation: $schedule-006

  • $input-SSS-RRR: The API will simulate that the order has been scheduled after SSS seconds, and then loaded in the robot RRR seconds after creation.

If you provide an invalid number, the order will be created but no demo behavior will be triggered.

Example:

  • input order into the robot 9 seconds after creation: $input-005-009

  • $pickup-SSS-RRR-PPP: The API will simulate that order has been scheduled after SSS seconds, and then loaded loaded in the robot RRR seconds after creation and then picked up PPP seconds after creation.

If you provide invalid numbers, the order will be created but no demo behavior will be triggered.

Examples:

  • input after 15 seconds and pickup after 30 seconds from creation: $pickup-005-015-030

  • input after 20 seconds but no pickup (because is before input): $pickup-010-020-005 (similar result to $input-010-020 but this will also make the order appear as overdue)

  • $cancel-SSS-RRR-CCC: The API will simulate that order has been scheduled after SSS seconds, and then loaded in the robot RRR seconds after creation and then cancelled CCC seconds after creation.

Examples:

  • input after 2 seconds and cancel after 7 seconds from creation: $cancel-001-002-007

  • cancel before input: $cancel-010-010-001

Both example will make the order appear as cancelled

  • $fail: The API will throw an unexpected error (this will allow you to test your error-handling code).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Information about the new recurrent order.

string
required
length between 1 and 64
string | null
string | null
boolean
boolean
date-time | null

The recurrent order start date; if it is null and EndDate is also null, StartDate will be the date when the order will be created (UTC) if it is null and EndDate is not null, StartDate will be set to EndDate

date-time | null

The recurrent order end date; if it is null and StartDate is also null, EndDate will be the date when the order will be created (UTC) if it is null and StartDate is not null, EndDate will be set to StartDate

customerDetails
object
articles
array of objects | null
articles
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

409

The combination (ordernumber1, ordernumber2) you provided is not unique (order already exists).

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json