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 | 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 | 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 | Bringg's ID for the recurring order template. |
schedule_type | The amount of time between orders for a recurring order template.
Possible values:
|
team_external_id | Your external system's ID for the assigned team. |