post https://developer-api.bringg.com/services/mk12rs9u///
Get all active recurring orders bycustomer_external_id
.
Send this request to receive a list of active recurring orders for a customer. Active recurring orders are those with start dates in the past and end dates in the future. Recurring orders with no start and end date are also active, as they are effective indefinitely.
To filter the list of recurring orders by team, include the team_external_id
in your request.
Response (Output) Params
Response
Parameter | Description |
---|---|
customer_external_id string | Your external system's ID for the customer. |
recurrent_task_templates array of objects | An array of recurring orders. |
Recurring Order Object
Parameter | Description |
---|---|
effective_end_date epochal datetime | The start of the time range within which the recurrence is active. For example, the start date may be April 1 with the first occurrence on April 2. |
effective_start_date epochal datetime | The end of the time range within which the recurrence is active. For example, the end date may be April 30 with the last occurrence on April 28. |
id integer | Bringg's ID for the recurring order template. |
schedule_type integer | The amount of time between orders for a recurring order template. Possible values: 1 - Every week2 - Every two weeks |
team_external_id string | Your external system's ID for the assigned team. |
Response Status Parameters
Parameter | Description |
---|---|
status enum | A code indicating the status of your request. If an error occurs, the specific error type is included. This code may also be indicated in the response as a type . Read more about error status codes.Example value: 400 |
success boolean | Indicates whether the service was completed successfully. Possible values: false - the service failed.true - the service succeeded |
title or message string | If an error occurs, a message describing the cause of the error is included. Example value: "Customer was not found by external id 12345" |
type string | If an error occurs, a URL explaining the type may be included. Example value: "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400" |