---
title: "Create repeat order."
method: POST
path: "/order/create_repeat"
tags: ["Orders|Order"]
---

# Create repeat order.

`POST /order/create_repeat`

This endpoint allows you to create a repeating order. To create a repeating order you need to provide an order
object and scheduling information. The created order will be repeated according to the scheduling configuration
provided.

Recurring orders in geoCapture are tasks scheduled to happen at regular intervals, like weekly, monthly, or
annually. They are designed for repetitive tasks that need to be done routinely, such as regular maintenance
checks or recurring deliveries. To illustrate, a recurring order could be set up for weekly landscape maintenance
at a specific location, meaning that the task is automatically scheduled at the designated frequency without
needing to create a new order every time. This function streamlines ongoing task management, boosting efficiency
and maintaining consistency in operations.

## Request body

- StandardOrderCreateRepeatRequest
  - `order` OrderCreateRepeatRequestOrderItem
    - `id` integer — The internal id of the order
    - `reference` string — The internal reference for the order (max. 64 characters)
    - `orderType` string — The order type. This parameter is optional. The allowed value and default is 'ORDER'
    - `externalReference` string — The customer order number (max. 64 characters)
    - `status` string — The order state | Value | | ------------------------ | | ARRIVAL | | ASSIGNED | | CREATED | | DEPARTURE | | FINISHED | | NEAREST_POSITION | | OPENED_BY_USER | | READ | | REJECTED | | SIGNED | | STARTED |
    - `subject` string — Order subject (max. 255 characters)
    - `text` string — Order description
    - `orderDate` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `duration` integer — The order duration
    - `priority` string — order priority | Value | | ------------------------ | | LOW | | NORMAL | | HIGH |
    - `targetDate` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `externalAddressId` string — The external customer id.
    - `name` string — The name1 address addition. (max. 255 characters)
    - `name2` string — The name2 address addition. (max. 255 characters)
    - `name3` string — The name3 address addition. (max. 255 characters)
    - `street` string — The street (max. 255 characters)
    - `zipCode` string — The zip code
    - `city` string — The city
    - `countryCode` string — The country code
    - `latLng` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
    - `contactPersonName` string — The contact person name (max. 255 characters)
    - `contactPersonEmail` string — The contact person email (max. 255 characters)
    - `contactPersonPhoneNumber` string — The contact person phone number (max. 64 characters)
    - `contactPersonMobileNumber` string — The contact person mobile phone number (max. 64 characters)
    - `customerOrderReference` string — The customer order reference (max. 64 characters)
    - `offerReference` string — The offer reference (max. 255 characters)
    - `category` integer — The id of the order category. You need to provide this Parameter or the categoryExternalId.
    - `categoryExternalId` string — The external id of the order category (Used if category not provided).
    - `type` string — | Values | | -------------- | | PROJECT | | CUSTOM_PROJECT |
    - `project` integer — The id of the project.
    - `projectReferenceSign` string — The reference sign of the project (Used if project not provided).
    - `createdAt` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `schedulerDefinition` OrderCreateRepeatRequestSchedulerDefinition
      - `type` string — The scheduler type (See the examples for every type above). | Values | Description | | ------------------ | ------------------------------------------------------------------------------------- | | daily | Every 'd' days | | dailyEveryWorkday | Every workday | | weekly | Every 'w' weeks on weekdays 'wd' | | monthlyNthDay | Every 'm' months on the 'dm' day of the month | | monthlyNthWeekday | Every 'm' months on the 'o' occurrence of the day of the week 'wd' | | yearlyNthDay | Every 'y' years on the specified date 'dm'.'my' | | yearlyNthWeekday | Every 'y' years on the 'o' occurrence of the day of the week 'wd' in the month 'my' |
      - `intervalDays` integer — Every x days. (d)
      - `weekdays` integer[] — Only on following weekdays: 1 = Monday, 7 = Sunday. (wd)
      - `intervalWeeks` integer — Every x weeks. (w)
      - `day` integer — Day of month. (dm)
      - `intervalMonths` integer — Every x months. (m)
      - `occurrence` integer — Every x specified weekday: 1 = first, 4 = fourth, 5 = last. (o)
      - `month` integer — Month of the year: 1 = January, 12 = December. (my)
      - `intervalYears` integer — Every x years. (y)
    - `schedulerStartDate` string — Represents a date. (ISO 8601) ICU-Format: yyyy-MM-dd
    - `schedulerEndDate` string — Represents a date. (ISO 8601) ICU-Format: yyyy-MM-dd
    - `schedulerMaxRuns` integer — The maximum amount of runs for this order. (Only one of schedulerEndDate and schedulerMaxRuns can be specified)

## Response `200`

Success Response:

- StandardOrderCreateRepeatResponse
  - `data` OrderCreateRepeatRequestOrderItem
    - `id` integer — The internal id of the order
    - `reference` string — The internal reference for the order (max. 64 characters)
    - `orderType` string — The order type. This parameter is optional. The allowed value and default is 'ORDER'
    - `externalReference` string — The customer order number (max. 64 characters)
    - `status` string — The order state | Value | | ------------------------ | | ARRIVAL | | ASSIGNED | | CREATED | | DEPARTURE | | FINISHED | | NEAREST_POSITION | | OPENED_BY_USER | | READ | | REJECTED | | SIGNED | | STARTED |
    - `subject` string — Order subject (max. 255 characters)
    - `text` string — Order description
    - `orderDate` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `duration` integer — The order duration
    - `priority` string — order priority | Value | | ------------------------ | | LOW | | NORMAL | | HIGH |
    - `targetDate` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `externalAddressId` string — The external customer id.
    - `name` string — The name1 address addition. (max. 255 characters)
    - `name2` string — The name2 address addition. (max. 255 characters)
    - `name3` string — The name3 address addition. (max. 255 characters)
    - `street` string — The street (max. 255 characters)
    - `zipCode` string — The zip code
    - `city` string — The city
    - `countryCode` string — The country code
    - `latLng` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
    - `contactPersonName` string — The contact person name (max. 255 characters)
    - `contactPersonEmail` string — The contact person email (max. 255 characters)
    - `contactPersonPhoneNumber` string — The contact person phone number (max. 64 characters)
    - `contactPersonMobileNumber` string — The contact person mobile phone number (max. 64 characters)
    - `customerOrderReference` string — The customer order reference (max. 64 characters)
    - `offerReference` string — The offer reference (max. 255 characters)
    - `category` integer — The id of the order category. You need to provide this Parameter or the categoryExternalId.
    - `categoryExternalId` string — The external id of the order category (Used if category not provided).
    - `type` string — | Values | | -------------- | | PROJECT | | CUSTOM_PROJECT |
    - `project` integer — The id of the project.
    - `projectReferenceSign` string — The reference sign of the project (Used if project not provided).
    - `createdAt` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `schedulerDefinition` OrderCreateRepeatRequestSchedulerDefinition
      - `type` string — The scheduler type (See the examples for every type above). | Values | Description | | ------------------ | ------------------------------------------------------------------------------------- | | daily | Every 'd' days | | dailyEveryWorkday | Every workday | | weekly | Every 'w' weeks on weekdays 'wd' | | monthlyNthDay | Every 'm' months on the 'dm' day of the month | | monthlyNthWeekday | Every 'm' months on the 'o' occurrence of the day of the week 'wd' | | yearlyNthDay | Every 'y' years on the specified date 'dm'.'my' | | yearlyNthWeekday | Every 'y' years on the 'o' occurrence of the day of the week 'wd' in the month 'my' |
      - `intervalDays` integer — Every x days. (d)
      - `weekdays` integer[] — Only on following weekdays: 1 = Monday, 7 = Sunday. (wd)
      - `intervalWeeks` integer — Every x weeks. (w)
      - `day` integer — Day of month. (dm)
      - `intervalMonths` integer — Every x months. (m)
      - `occurrence` integer — Every x specified weekday: 1 = first, 4 = fourth, 5 = last. (o)
      - `month` integer — Month of the year: 1 = January, 12 = December. (my)
      - `intervalYears` integer — Every x years. (y)
    - `schedulerStartDate` string — Represents a date. (ISO 8601) ICU-Format: yyyy-MM-dd
    - `schedulerEndDate` string — Represents a date. (ISO 8601) ICU-Format: yyyy-MM-dd
    - `schedulerMaxRuns` integer — The maximum amount of runs for this order. (Only one of schedulerEndDate and schedulerMaxRuns can be specified)

---

[API](https://skmtc.net/geocapture/apis/geocapture-api.md) · [All operations](https://skmtc.net/geocapture/apis/geocapture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/geocapture/geocapture-api/versions/15839b24c497/schema)