Create or update a plan's order

Error

A valid request URL is required to generate request examples

{
  "item": {
    "id": "<string>",
    "stops": [
      {
        "id": "<string>",
        "position": {
          "lon": 2.3269331,
          "lat": 48.8812658
        },
        "type": "single",
        "properties": {},
        "tags": [
          "access:parking33",
          "capa:bat22",
          "setup:france"
        ],
        "kind": "delivery",
        "operationDuration": "PT4M",
        "capacities": {
          "volume": 9.5,
          "weight": 2200,
          "nbPackages": 23
        },
        "authorizedTimeWindows": [
          {
            "begin": "2019-11-15T12:34:56Z",
            "end": "2019-11-15T12:34:56Z",
            "resourceTags": [
              "subcontractorA",
              "subcontractorB"
            ]
          }
        ],
        "preferredTimeWindows": [
          {
            "begin": "2019-11-15T12:34:56Z",
            "end": "2019-11-15T12:34:56Z",
            "resourceTags": [
              "subcontractorA",
              "subcontractorB"
            ]
          }
        ]
      }
    ],
    "properties": {},
    "priority": 0,
    "optional": true,
    "requiredSkills": [
      "forklift",
      "truck"
    ],
    "successiveStops": true,
    "maxStopSpan": "PT4M"
  },
  "agencyId": "LND_Agency-42",
  "planId": "plan-AB",
  "planVersion": 42
}

{
  "item": {
    "id": "<string>",
    "stops": [
      {
        "id": "<string>",
        "position": {
          "lon": 2.3269331,
          "lat": 48.8812658
        },
        "type": "single",
        "properties": {},
        "tags": [
          "access:parking33",
          "capa:bat22",
          "setup:france"
        ],
        "kind": "delivery",
        "operationDuration": "PT4M",
        "capacities": {
          "volume": 9.5,
          "weight": 2200,
          "nbPackages": 23
        },
        "authorizedTimeWindows": [
          {
            "begin": "2019-11-15T12:34:56Z",
            "end": "2019-11-15T12:34:56Z",
            "resourceTags": [
              "subcontractorA",
              "subcontractorB"
            ]
          }
        ],
        "preferredTimeWindows": [
          {
            "begin": "2019-11-15T12:34:56Z",
            "end": "2019-11-15T12:34:56Z",
            "resourceTags": [
              "subcontractorA",
              "subcontractorB"
            ]
          }
        ]
      }
    ],
    "properties": {},
    "priority": 0,
    "optional": true,
    "requiredSkills": [
      "forklift",
      "truck"
    ],
    "successiveStops": true,
    "maxStopSpan": "PT4M"
  },
  "agencyId": "LND_Agency-42",
  "planId": "plan-AB",
  "planVersion": 42
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

PUT

agencies

{agencyId}

plans

{planId}

orders

{orderId}

Error

A valid request URL is required to generate request examples

{
  "item": {
    "id": "<string>",
    "stops": [
      {
        "id": "<string>",
        "position": {
          "lon": 2.3269331,
          "lat": 48.8812658
        },
        "type": "single",
        "properties": {},
        "tags": [
          "access:parking33",
          "capa:bat22",
          "setup:france"
        ],
        "kind": "delivery",
        "operationDuration": "PT4M",
        "capacities": {
          "volume": 9.5,
          "weight": 2200,
          "nbPackages": 23
        },
        "authorizedTimeWindows": [
          {
            "begin": "2019-11-15T12:34:56Z",
            "end": "2019-11-15T12:34:56Z",
            "resourceTags": [
              "subcontractorA",
              "subcontractorB"
            ]
          }
        ],
        "preferredTimeWindows": [
          {
            "begin": "2019-11-15T12:34:56Z",
            "end": "2019-11-15T12:34:56Z",
            "resourceTags": [
              "subcontractorA",
              "subcontractorB"
            ]
          }
        ]
      }
    ],
    "properties": {},
    "priority": 0,
    "optional": true,
    "requiredSkills": [
      "forklift",
      "truck"
    ],
    "successiveStops": true,
    "maxStopSpan": "PT4M"
  },
  "agencyId": "LND_Agency-42",
  "planId": "plan-AB",
  "planVersion": 42
}

{
  "item": {
    "id": "<string>",
    "stops": [
      {
        "id": "<string>",
        "position": {
          "lon": 2.3269331,
          "lat": 48.8812658
        },
        "type": "single",
        "properties": {},
        "tags": [
          "access:parking33",
          "capa:bat22",
          "setup:france"
        ],
        "kind": "delivery",
        "operationDuration": "PT4M",
        "capacities": {
          "volume": 9.5,
          "weight": 2200,
          "nbPackages": 23
        },
        "authorizedTimeWindows": [
          {
            "begin": "2019-11-15T12:34:56Z",
            "end": "2019-11-15T12:34:56Z",
            "resourceTags": [
              "subcontractorA",
              "subcontractorB"
            ]
          }
        ],
        "preferredTimeWindows": [
          {
            "begin": "2019-11-15T12:34:56Z",
            "end": "2019-11-15T12:34:56Z",
            "resourceTags": [
              "subcontractorA",
              "subcontractorB"
            ]
          }
        ]
      }
    ],
    "properties": {},
    "priority": 0,
    "optional": true,
    "requiredSkills": [
      "forklift",
      "truck"
    ],
    "successiveStops": true,
    "maxStopSpan": "PT4M"
  },
  "agencyId": "LND_Agency-42",
  "planId": "plan-AB",
  "planVersion": 42
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agencyId

string

required

The agency id.

Pattern: ^[A-Z]{3,6}_[a-zA-Z0-9-._~:@!$,]+$

Example:

"LND_Agency-42"

planId

string

required

The plan id. At least one character among those allowed: unaccented alpha-numeric characters, "-", ".", "_", "~", ":", "@", "!", "$", ",".

Pattern: ^[a-zA-Z0-9-._~:@!$,]+$

orderId

string

required

The order id. At least one character among those allowed: unaccented alpha-numeric characters, "-", ".", "_", "~", ":", "@", "!", "$", ",".

Pattern: ^[a-zA-Z0-9-._~:@!$,]+$

Query Parameters

force

boolean

default:false

If true, on an archived item, the requested action will be forced and the item will be unarchived.

Body

application/json

The Order to update.

[TO_VALIDATE] Description pending review by a Kardinal engineer.

string

required

Order ids must be unique within a plan.

Pattern: ^[a-zA-Z0-9-._~:@!$,]+$

stops

object[]

required

The ordered list of stops that make up this order. All stops of an order are planned onto the same resource, and their position in this array acts as a precedence constraint: the first stop must be visited before the second, and so on.

[TO_VALIDATE] Description pending review by a Kardinal engineer.

Option 1
Option 2

Show child attributes

properties

object

Free-form key-value pairs (strings only) with no impact on optimization, such as a client reference. Returned unchanged in the plan and its solution.

Show child attributes

priority

integer

default:0

0 by default, can be negative.

optional

boolean

When true, this order is not mandatory: the algorithm may leave it unplanned without affecting the maximizeMandatoryStops objective, though it can still be scheduled via the maximizeOptionalStops objective. A shorthand for giving the order the lowest priority.

requiredSkills

string[]

At least one character among those allowed: unaccented alpha-numeric characters, "-", ".", "_", "~", ":", "@", "!", "$", ",".

Pattern: ^[a-zA-Z0-9-._~:@!$,]+$

Example:

["forklift", "truck"]

successiveStops

boolean

This constraint specifies that the stops within this order must be performed consecutively, without any intermediate stops from other orders. Useful when containers cannot be mixed, or to maintain a strict sequence of tasks. Mutually exclusive with maxStopSpan: only one of the two should be used.

maxStopSpan

string

A period of time, expressed in the ISO8601 duration format.

Pattern: ^P(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(\d+H)?(\d+M)?(\d+S)?)?$

Example:

"PT4M"

Response

Order response updated.

[TO_VALIDATE] Description pending review by a Kardinal engineer.

item

object

[TO_VALIDATE] Description pending review by a Kardinal engineer.

Show child attributes

agencyId

string

The agency id.

Pattern: ^[A-Z]{3,6}_[a-zA-Z0-9-._~:@!$,]+$

Example:

"LND_Agency-42"

planId

string

The plan id.

Pattern: ^[a-zA-Z0-9-._~:@!$,]+$

Example:

"plan-AB"

planVersion

integer

read-only

The plan version.

Required range: x >= 1

Example:

42

API

Data model

Changes

Create or update a plan's order

Authorizations

Path Parameters

Query Parameters

Body

Response