v1

latestOpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB

Orders|Order

Create/Update orders.

This method can be used to create and update orders.

An attempt is made to find an existing order based on the selected primary key and value of the key provided. If one is found, it will be adjusted. Otherwise, a new order is created. If you want, you can remove missing entries from the upsert request by setting the 'deleteMissing' flag to true.

post/order/upsert

Request body

deleteMissingboolean

Do you want to delete all orders missing from this request? This Parameter is optional. (default=false)

dryRunboolean

Simulate the operation. (No records will be created or changed) This Parameter is optional.

Example request

{
  "records": [
    {
      "data": {
        "orderDate": "2015-02-20T12:59:21+01:00",
        "targetDate": "2015-02-20T12:59:21+01:00",
        "latLng": [
          52.38127828631681,
          7.594243214018696
        ],
        "createdAt": "2015-02-20T12:59:21+01:00",
        "openingHours": {
          "MO": [
            [
              "08:00",
              "13:00"
            ]
          ],
          "TU": [
            [
              "08:00",
              "13:00"
            ]
          ],
          "WE": [
            [
              "08:00",
              "13:00"
            ]
          ],
          "TH": [
            [
              "08:00",
              "13:00"
            ]
          ],
          "FR": [
            [
              "08:00",
              "13:00"
            ]
          ],
          "SA": [
            [
              "08:00",
              "13:00"
            ]
          ],
          "SU": [
            [
              "08:00",
              "13:00"
            ]
          ]
        }
      }
    }
  ]
}

Response

Success Response:

Example response

{
  "createdOrders": [
    {
      "orderDate": "2015-02-20T12:59:21+01:00",
      "targetDate": "2015-02-20T12:59:21+01:00",
      "latLng": [
        52.38127828631681,
        7.594243214018696
      ],
      "createdAt": "2015-02-20T12:59:21+01:00",
      "openingHours": {
        "MO": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "TU": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "WE": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "TH": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "FR": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "SA": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "SU": [
          [
            "08:00",
            "13:00"
          ]
        ]
      },
      "requiredQualifications": [
        {
          "createdAt": "2015-02-20T12:59:21+01:00"
        }
      ],
      "rejectQualifications": [
        {
          "createdAt": "2015-02-20T12:59:21+01:00"
        }
      ],
      "requireOneQualifications": [
        {
          "createdAt": "2015-02-20T12:59:21+01:00"
        }
      ]
    }
  ],
  "updatedOrders": [
    {
      "orderDate": "2015-02-20T12:59:21+01:00",
      "targetDate": "2015-02-20T12:59:21+01:00",
      "latLng": [
        52.38127828631681,
        7.594243214018696
      ],
      "createdAt": "2015-02-20T12:59:21+01:00",
      "openingHours": {
        "MO": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "TU": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "WE": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "TH": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "FR": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "SA": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "SU": [
          [
            "08:00",
            "13:00"
          ]
        ]
      },
      "requiredQualifications": [
        {
          "createdAt": "2015-02-20T12:59:21+01:00"
        }
      ],
      "rejectQualifications": [
        {
          "createdAt": "2015-02-20T12:59:21+01:00"
        }
      ],
      "requireOneQualifications": [
        {
          "createdAt": "2015-02-20T12:59:21+01:00"
        }
      ]
    }
  ],
  "deletedOrders": [
    {
      "orderDate": "2015-02-20T12:59:21+01:00",
      "targetDate": "2015-02-20T12:59:21+01:00",
      "latLng": [
        52.38127828631681,
        7.594243214018696
      ],
      "createdAt": "2015-02-20T12:59:21+01:00",
      "openingHours": {
        "MO": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "TU": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "WE": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "TH": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "FR": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "SA": [
          [
            "08:00",
            "13:00"
          ]
        ],
        "SU": [
          [
            "08:00",
            "13:00"
          ]
        ]
      },
      "requiredQualifications": [
        {
          "createdAt": "2015-02-20T12:59:21+01:00"
        }
      ],
      "rejectQualifications": [
        {
          "createdAt": "2015-02-20T12:59:21+01:00"
        }
      ],
      "requireOneQualifications": [
        {
          "createdAt": "2015-02-20T12:59:21+01:00"
        }
      ]
    }
  ]
}