Orders endpoints

List orders

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25

tenantOrderIdstringOptional

filter orders by tenantOrderId

consumerIdstringOptional

filter orders by consumerId

Responses

200

Orders are found.

application/json

StrippedOrders

totalintegerOptional

Total number of found entities for this query

Example: 42

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

get

/api/orders

HTTPcURLJavaScriptPython

GET /api/orders HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "orders": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "id": "LGMl2DuvPnfPoSHhYFOm",
      "orderDate": "2020-02-03T08:45:50.525Z",
      "orderLineItems": [
        {
          "quantity": 21,
          "title": "Cologne Water"
        }
      ],
      "processRef": "text",
      "status": "OPEN",
      "stickers": []
    }
  ],
  "total": 42
}

Create order

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

OrderForCreation

customAttributesobjectOptional

Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.

orderDatestring · date-timeRequired

The date this order was created at the supplying system.

Example: 2020-02-03T08:45:50.525Z

statusstring · enumOptional

The state of the order. Initially it is OPEN.

Possible values:

tenantOrderIdstringOptional

Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.

Example: R456728546

Responses

201

The order was successfully created. The Location header contains the URL of the order.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

/api/orders

HTTPcURLJavaScriptPython

POST /api/orders HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3545

{
  "consumer": {
    "addresses": [
      {
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      }
    ],
    "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "customAttributes": {},
    "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "tenantFacilityId": "text"
  },
  "customAttributes": {},
  "customServices": [
    {
      "articleItems": [
        {
          "quantity": 1,
          "tenantArticleRef": "text"
        }
      ],
      "customServiceDefinition": {
        "additionalInformation": [
          {
            "additionalInformationRef": "text",
            "tenantAdditionalInformationId": "text",
            "value": "text"
          }
        ],
        "customAttributes": {},
        "customServiceRef": "text",
        "isBundled": true,
        "tenantCustomServiceId": "text"
      },
      "customServiceItems": [
        {
          "articleItems": [
            {
              "quantity": 1,
              "tenantArticleRef": "text"
            }
          ],
          "customServiceDefinition": {
            "additionalInformation": [
              {
                "additionalInformationRef": "text",
                "tenantAdditionalInformationId": "text",
                "value": "text"
              }
            ],
            "customAttributes": {},
            "customServiceRef": "text",
            "isBundled": true,
            "tenantCustomServiceId": "text"
          },
          "customServiceItems": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ],
  "deliveryPreferences": {
    "collect": [
      null
    ],
    "reservationPreferences": {
      "mode": "SCHEDULED",
      "reservationTime": "2020-02-03T09:45:51.525Z"
    },
    "shipping": {
      "carrierProductCategory": "STANDARD",
      "desiredDeliveryTime": "2020-02-03T09:45:51.525Z",
      "preferredCarriers": [
        "text"
      ],
      "preferredCarriersWithProduct": [],
      "preselectedFacilities": [
        null
      ],
      "serviceLevel": "DELIVERY"
    },
    "sourcingOptionRefs": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "supplyingFacilities": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "targetTime": "2020-02-03T09:45:51.525Z"
  },
  "orderDate": "2020-02-03T08:45:50.525Z",
  "orderLineItems": [
    {
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "customAttributes": {},
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "liter",
      "secondaryQuantity": 21,
      "shopPrice": 1200,
      "tags": []
    }
  ],
  "paymentInfo": {
    "methodLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "currency": "EUR"
  },
  "promisesOptions": {
    "validUntil": "2020-02-03T08:45:50.525Z"
  },
  "status": "OPEN",
  "statusReasons": [],
  "stickers": [],
  "tenantOrderId": "R456728546",
  "tags": []
}

{
  "consumer": {
    "addresses": [
      {
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      }
    ],
    "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "customAttributes": {},
    "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "tenantFacilityId": "text"
  },
  "customAttributes": {},
  "customServices": [
    {
      "articleItems": [
        {
          "quantity": 1,
          "tenantArticleRef": "text"
        }
      ],
      "customServiceDefinition": {
        "additionalInformation": [
          {
            "additionalInformationRef": "text",
            "tenantAdditionalInformationId": "text",
            "value": "text"
          }
        ],
        "customAttributes": {},
        "customServiceRef": "text",
        "isBundled": true,
        "tenantCustomServiceId": "text"
      },
      "customServiceItems": [
        {}
      ],
      "id": "text"
    }
  ],
  "deliveryPreferences": {
    "collect": [
      null
    ],
    "reservationPreferences": {
      "mode": "SCHEDULED",
      "reservationTime": "2020-02-03T09:45:51.525Z"
    },
    "shipping": {
      "carrierProductCategory": "STANDARD",
      "desiredDeliveryTime": "2020-02-03T09:45:51.525Z",
      "preferredCarriers": [
        "text"
      ],
      "preferredCarriersWithProduct": [],
      "preselectedFacilities": [
        null
      ],
      "serviceLevel": "DELIVERY"
    },
    "sourcingOptionRefs": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "supplyingFacilities": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "targetTime": "2020-02-03T09:45:51.525Z"
  },
  "orderDate": "2020-02-03T08:45:50.525Z",
  "orderLineItems": [
    {
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "customAttributes": {},
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "liter",
      "secondaryQuantity": 21,
      "shopPrice": 1200,
      "tags": [],
      "id": "LGMl2DuvPnfPoSHhYFOm"
    }
  ],
  "paymentInfo": {
    "methodLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "currency": "EUR",
    "method": "Credit Card"
  },
  "promisesOptions": {
    "validUntil": "2020-02-03T08:45:50.525Z"
  },
  "status": "OPEN",
  "statusReasons": [],
  "stickers": [],
  "tenantOrderId": "R456728546",
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "cancelationReason": {
    "action": "text",
    "id": "text",
    "reasonLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "reason": "Rerouted because of an issue in the Facility.",
    "created": "2020-02-03T08:45:51.525Z",
    "lastModified": "2020-02-03T09:45:51.525Z",
    "version": 42
  },
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "processId": "text",
  "schemaVersion": 1,
  "updateDetails": [
    {
      "changes": {
        "consumer": {
          "addresses": [
            {
              "additionalAddressInfo": "to care of: Mrs. Müller",
              "city": "Langenfeld",
              "country": "DE",
              "customAttributes": {},
              "houseNumber": "42a",
              "phoneNumbers": [
                {
                  "customAttributes": {},
                  "label": "text",
                  "type": "MOBILE",
                  "value": "text"
                }
              ],
              "postalCode": "40764",
              "province": "NRW",
              "street": "Hauptstr."
            }
          ],
          "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
          "customAttributes": {},
          "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
          "tenantFacilityId": "text"
        },
        "customAttributes": {},
        "orderLineItems": [],
        "preferredHandlingTime": "2025-01-15T00:00:00.000Z"
      },
      "comment": "text",
      "created": "2020-02-03T08:45:50.525Z",
      "user": "text"
    }
  ]
}

Update order

patch

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orderIdstringRequired

ID of Order you want to patch

Body

application/json

OrderForUpdate

commentstringOptional

A comment for updating this order.

customAttributesobject · nullableOptional

Attributes that can be added to the order. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.

orderLineItemsany · nullableOptional

Updates the order line items of the order. All order lines must be included, only the included lines will remain after the update. type: array

preferredHandlingTimestring · date-timeOptional

Updates the preferred handling time for ship-from-store orders or the provisioning time for click-and-collect orders.

Example: 2025-01-15T00:00:00.000Z

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

Responses

200

Order was found & patch-set has been applied. The patched entity is in the body.

application/json

Order

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found, for more information please look at details.

application/json

patch

/api/orders/{orderId}

HTTPcURLJavaScriptPython

PATCH /api/orders/{orderId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 580

{
  "comment": "text",
  "consumer": {
    "addresses": [
      {
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      }
    ],
    "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "customAttributes": {},
    "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "tenantFacilityId": "text"
  },
  "customAttributes": {},
  "orderLineItems": [],
  "preferredHandlingTime": "2025-01-15T00:00:00.000Z",
  "version": 42
}

{
  "consumer": {
    "addresses": [
      {
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      }
    ],
    "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "customAttributes": {},
    "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "tenantFacilityId": "text"
  },
  "customAttributes": {},
  "customServices": [
    {
      "articleItems": [
        {
          "quantity": 1,
          "tenantArticleRef": "text"
        }
      ],
      "customServiceDefinition": {
        "additionalInformation": [
          {
            "additionalInformationRef": "text",
            "tenantAdditionalInformationId": "text",
            "value": "text"
          }
        ],
        "customAttributes": {},
        "customServiceRef": "text",
        "isBundled": true,
        "tenantCustomServiceId": "text"
      },
      "customServiceItems": [
        {}
      ],
      "id": "text"
    }
  ],
  "deliveryPreferences": {
    "collect": [
      null
    ],
    "reservationPreferences": {
      "mode": "SCHEDULED",
      "reservationTime": "2020-02-03T09:45:51.525Z"
    },
    "shipping": {
      "carrierProductCategory": "STANDARD",
      "desiredDeliveryTime": "2020-02-03T09:45:51.525Z",
      "preferredCarriers": [
        "text"
      ],
      "preferredCarriersWithProduct": [],
      "preselectedFacilities": [
        null
      ],
      "serviceLevel": "DELIVERY"
    },
    "sourcingOptionRefs": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "supplyingFacilities": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "targetTime": "2020-02-03T09:45:51.525Z"
  },
  "orderDate": "2020-02-03T08:45:50.525Z",
  "orderLineItems": [
    {
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "customAttributes": {},
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "liter",
      "secondaryQuantity": 21,
      "shopPrice": 1200,
      "tags": [],
      "id": "LGMl2DuvPnfPoSHhYFOm"
    }
  ],
  "paymentInfo": {
    "methodLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "currency": "EUR",
    "method": "Credit Card"
  },
  "promisesOptions": {
    "validUntil": "2020-02-03T08:45:50.525Z"
  },
  "status": "OPEN",
  "statusReasons": [],
  "stickers": [],
  "tenantOrderId": "R456728546",
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "cancelationReason": {
    "action": "text",
    "id": "text",
    "reasonLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "reason": "Rerouted because of an issue in the Facility.",
    "created": "2020-02-03T08:45:51.525Z",
    "lastModified": "2020-02-03T09:45:51.525Z",
    "version": 42
  },
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "processId": "text",
  "schemaVersion": 1,
  "updateDetails": [
    {
      "changes": {
        "consumer": {
          "addresses": [
            {
              "additionalAddressInfo": "to care of: Mrs. Müller",
              "city": "Langenfeld",
              "country": "DE",
              "customAttributes": {},
              "houseNumber": "42a",
              "phoneNumbers": [
                {
                  "customAttributes": {},
                  "label": "text",
                  "type": "MOBILE",
                  "value": "text"
                }
              ],
              "postalCode": "40764",
              "province": "NRW",
              "street": "Hauptstr."
            }
          ],
          "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
          "customAttributes": {},
          "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
          "tenantFacilityId": "text"
        },
        "customAttributes": {},
        "orderLineItems": [],
        "preferredHandlingTime": "2025-01-15T00:00:00.000Z"
      },
      "comment": "text",
      "created": "2020-02-03T08:45:50.525Z",
      "user": "text"
    }
  ]
}

Get order

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orderIdstringRequired

ID of order you want to get

Responses

200

Order was found & you were allowed to access it. The result is in the body.

application/json

Order

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get

/api/orders/{orderId}

HTTPcURLJavaScriptPython

GET /api/orders/{orderId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "consumer": {
    "addresses": [
      {
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      }
    ],
    "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "customAttributes": {},
    "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "tenantFacilityId": "text"
  },
  "customAttributes": {},
  "customServices": [
    {
      "articleItems": [
        {
          "quantity": 1,
          "tenantArticleRef": "text"
        }
      ],
      "customServiceDefinition": {
        "additionalInformation": [
          {
            "additionalInformationRef": "text",
            "tenantAdditionalInformationId": "text",
            "value": "text"
          }
        ],
        "customAttributes": {},
        "customServiceRef": "text",
        "isBundled": true,
        "tenantCustomServiceId": "text"
      },
      "customServiceItems": [
        {}
      ],
      "id": "text"
    }
  ],
  "deliveryPreferences": {
    "collect": [
      null
    ],
    "reservationPreferences": {
      "mode": "SCHEDULED",
      "reservationTime": "2020-02-03T09:45:51.525Z"
    },
    "shipping": {
      "carrierProductCategory": "STANDARD",
      "desiredDeliveryTime": "2020-02-03T09:45:51.525Z",
      "preferredCarriers": [
        "text"
      ],
      "preferredCarriersWithProduct": [],
      "preselectedFacilities": [
        null
      ],
      "serviceLevel": "DELIVERY"
    },
    "sourcingOptionRefs": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "supplyingFacilities": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "targetTime": "2020-02-03T09:45:51.525Z"
  },
  "orderDate": "2020-02-03T08:45:50.525Z",
  "orderLineItems": [
    {
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "customAttributes": {},
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "liter",
      "secondaryQuantity": 21,
      "shopPrice": 1200,
      "tags": [],
      "id": "LGMl2DuvPnfPoSHhYFOm"
    }
  ],
  "paymentInfo": {
    "methodLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "currency": "EUR",
    "method": "Credit Card"
  },
  "promisesOptions": {
    "validUntil": "2020-02-03T08:45:50.525Z"
  },
  "status": "OPEN",
  "statusReasons": [],
  "stickers": [],
  "tenantOrderId": "R456728546",
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "cancelationReason": {
    "action": "text",
    "id": "text",
    "reasonLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "reason": "Rerouted because of an issue in the Facility.",
    "created": "2020-02-03T08:45:51.525Z",
    "lastModified": "2020-02-03T09:45:51.525Z",
    "version": 42
  },
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "processId": "text",
  "schemaVersion": 1,
  "updateDetails": [
    {
      "changes": {
        "consumer": {
          "addresses": [
            {
              "additionalAddressInfo": "to care of: Mrs. Müller",
              "city": "Langenfeld",
              "country": "DE",
              "customAttributes": {},
              "houseNumber": "42a",
              "phoneNumbers": [
                {
                  "customAttributes": {},
                  "label": "text",
                  "type": "MOBILE",
                  "value": "text"
                }
              ],
              "postalCode": "40764",
              "province": "NRW",
              "street": "Hauptstr."
            }
          ],
          "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
          "customAttributes": {},
          "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
          "tenantFacilityId": "text"
        },
        "customAttributes": {},
        "orderLineItems": [],
        "preferredHandlingTime": "2025-01-15T00:00:00.000Z"
      },
      "comment": "text",
      "created": "2020-02-03T08:45:50.525Z",
      "user": "text"
    }
  ]
}

List orders (search)

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Search for Order

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

OrderSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses

200

Your search result

application/json

OrderPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

post

/api/orders/search

HTTPcURLJavaScriptPython

POST /api/orders/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13962

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "consumer": {
              "addresses": {
                "contains": {
                  "addressType": {
                    "eq": "POSTAL_ADDRESS",
                    "in": [
                      "POSTAL_ADDRESS"
                    ],
                    "notEq": "POSTAL_ADDRESS"
                  },
                  "city": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "companyName": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "country": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "email": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "firstName": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "houseNumber": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "lastName": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "postalCode": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "province": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "street": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              },
              "consumerId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "deliveryPreferences": {
              "collect": {
                "contains": {
                  "facilityRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "paid": {
                    "eq": true,
                    "notEq": true
                  }
                }
              },
              "shipping": {
                "desiredDeliveryTime": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T16:38:15.872Z",
                  "gt": "2026-03-02T16:38:15.872Z",
                  "gte": "2026-03-02T16:38:15.872Z",
                  "lt": "2026-03-02T16:38:15.872Z",
                  "lte": "2026-03-02T16:38:15.872Z",
                  "notEq": "2026-03-02T16:38:15.872Z"
                },
                "serviceLevel": {
                  "eq": "DELIVERY",
                  "in": [
                    "DELIVERY"
                  ],
                  "notEq": "DELIVERY"
                }
              }
            },
            "or": "[Circular Reference]",
            "orderDate": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T16:38:15.872Z",
              "gt": "2026-03-02T16:38:15.872Z",
              "gte": "2026-03-02T16:38:15.872Z",
              "lt": "2026-03-02T16:38:15.872Z",
              "lte": "2026-03-02T16:38:15.872Z",
              "notEq": "2026-03-02T16:38:15.872Z"
            },
            "orderLineItems": {
              "contains": {
                "article": {
                  "titleLocalized": {
                    "de_DE": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    },
                    "en_US": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    },
                    "ru_RU": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  },
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "paymentInfo": {
              "methodLocalized": {
                "de_DE": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "en_US": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "ru_RU": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "currency": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "method": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "tags": {
              "contains": {
                "value": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "consumer": {
          "addresses": {
            "contains": {
              "addressType": {
                "eq": "POSTAL_ADDRESS",
                "in": [
                  "POSTAL_ADDRESS"
                ],
                "notEq": "POSTAL_ADDRESS"
              },
              "city": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "country": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "firstName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "houseNumber": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "lastName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "postalCode": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "province": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "street": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          },
          "consumerId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "deliveryPreferences": {
          "collect": {
            "contains": {
              "facilityRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "paid": {
                "eq": true,
                "notEq": true
              }
            }
          },
          "shipping": {
            "desiredDeliveryTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T16:38:15.872Z",
              "gt": "2026-03-02T16:38:15.872Z",
              "gte": "2026-03-02T16:38:15.872Z",
              "lt": "2026-03-02T16:38:15.872Z",
              "lte": "2026-03-02T16:38:15.872Z",
              "notEq": "2026-03-02T16:38:15.872Z"
            },
            "serviceLevel": {
              "eq": "DELIVERY",
              "in": [
                "DELIVERY"
              ],
              "notEq": "DELIVERY"
            }
          }
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "consumer": {
              "addresses": {
                "contains": {
                  "addressType": {
                    "eq": "POSTAL_ADDRESS",
                    "in": [
                      "POSTAL_ADDRESS"
                    ],
                    "notEq": "POSTAL_ADDRESS"
                  },
                  "city": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "companyName": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "country": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "email": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "firstName": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "houseNumber": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "lastName": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "postalCode": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "province": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "street": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              },
              "consumerId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "deliveryPreferences": {
              "collect": {
                "contains": {
                  "facilityRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "paid": {
                    "eq": true,
                    "notEq": true
                  }
                }
              },
              "shipping": {
                "desiredDeliveryTime": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T16:38:15.872Z",
                  "gt": "2026-03-02T16:38:15.872Z",
                  "gte": "2026-03-02T16:38:15.872Z",
                  "lt": "2026-03-02T16:38:15.872Z",
                  "lte": "2026-03-02T16:38:15.872Z",
                  "notEq": "2026-03-02T16:38:15.872Z"
                },
                "serviceLevel": {
                  "eq": "DELIVERY",
                  "in": [
                    "DELIVERY"
                  ],
                  "notEq": "DELIVERY"
                }
              }
            },
            "or": "[Circular Reference]",
            "orderDate": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T16:38:15.872Z",
              "gt": "2026-03-02T16:38:15.872Z",
              "gte": "2026-03-02T16:38:15.872Z",
              "lt": "2026-03-02T16:38:15.872Z",
              "lte": "2026-03-02T16:38:15.872Z",
              "notEq": "2026-03-02T16:38:15.872Z"
            },
            "orderLineItems": {
              "contains": {
                "article": {
                  "titleLocalized": {
                    "de_DE": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    },
                    "en_US": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    },
                    "ru_RU": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  },
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "paymentInfo": {
              "methodLocalized": {
                "de_DE": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "en_US": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "ru_RU": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "currency": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "method": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "tags": {
              "contains": {
                "value": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "orderDate": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T16:38:15.872Z",
          "gt": "2026-03-02T16:38:15.872Z",
          "gte": "2026-03-02T16:38:15.872Z",
          "lt": "2026-03-02T16:38:15.872Z",
          "lte": "2026-03-02T16:38:15.872Z",
          "notEq": "2026-03-02T16:38:15.872Z"
        },
        "orderLineItems": {
          "contains": {
            "article": {
              "titleLocalized": {
                "de_DE": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "en_US": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "ru_RU": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "paymentInfo": {
          "methodLocalized": {
            "de_DE": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "en_US": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "ru_RU": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "currency": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "method": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "tags": {
          "contains": {
            "value": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "consumer": {
      "addresses": {
        "contains": {
          "addressType": {
            "eq": "POSTAL_ADDRESS",
            "in": [
              "POSTAL_ADDRESS"
            ],
            "notEq": "POSTAL_ADDRESS"
          },
          "city": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "country": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "firstName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "houseNumber": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "lastName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "postalCode": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "province": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "street": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        }
      },
      "consumerId": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "deliveryPreferences": {
      "collect": {
        "contains": {
          "facilityRef": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "paid": {
            "eq": true,
            "notEq": true
          }
        }
      },
      "shipping": {
        "desiredDeliveryTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T16:38:15.872Z",
          "gt": "2026-03-02T16:38:15.872Z",
          "gte": "2026-03-02T16:38:15.872Z",
          "lt": "2026-03-02T16:38:15.872Z",
          "lte": "2026-03-02T16:38:15.872Z",
          "notEq": "2026-03-02T16:38:15.872Z"
        },
        "serviceLevel": {
          "eq": "DELIVERY",
          "in": [
            "DELIVERY"
          ],
          "notEq": "DELIVERY"
        }
      }
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "consumer": {
          "addresses": {
            "contains": {
              "addressType": {
                "eq": "POSTAL_ADDRESS",
                "in": [
                  "POSTAL_ADDRESS"
                ],
                "notEq": "POSTAL_ADDRESS"
              },
              "city": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "country": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "firstName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "houseNumber": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "lastName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "postalCode": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "province": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "street": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          },
          "consumerId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "deliveryPreferences": {
          "collect": {
            "contains": {
              "facilityRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "paid": {
                "eq": true,
                "notEq": true
              }
            }
          },
          "shipping": {
            "desiredDeliveryTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T16:38:15.872Z",
              "gt": "2026-03-02T16:38:15.872Z",
              "gte": "2026-03-02T16:38:15.872Z",
              "lt": "2026-03-02T16:38:15.872Z",
              "lte": "2026-03-02T16:38:15.872Z",
              "notEq": "2026-03-02T16:38:15.872Z"
            },
            "serviceLevel": {
              "eq": "DELIVERY",
              "in": [
                "DELIVERY"
              ],
              "notEq": "DELIVERY"
            }
          }
        },
        "or": "[Circular Reference]",
        "orderDate": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T16:38:15.872Z",
          "gt": "2026-03-02T16:38:15.872Z",
          "gte": "2026-03-02T16:38:15.872Z",
          "lt": "2026-03-02T16:38:15.872Z",
          "lte": "2026-03-02T16:38:15.872Z",
          "notEq": "2026-03-02T16:38:15.872Z"
        },
        "orderLineItems": {
          "contains": {
            "article": {
              "titleLocalized": {
                "de_DE": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "en_US": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "ru_RU": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "paymentInfo": {
          "methodLocalized": {
            "de_DE": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "en_US": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "ru_RU": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "currency": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "method": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "tags": {
          "contains": {
            "value": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "orderDate": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T16:38:15.872Z",
      "gt": "2026-03-02T16:38:15.872Z",
      "gte": "2026-03-02T16:38:15.872Z",
      "lt": "2026-03-02T16:38:15.872Z",
      "lte": "2026-03-02T16:38:15.872Z",
      "notEq": "2026-03-02T16:38:15.872Z"
    },
    "orderLineItems": {
      "contains": {
        "article": {
          "titleLocalized": {
            "de_DE": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "en_US": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "ru_RU": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "tenantArticleId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "title": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        }
      }
    },
    "paymentInfo": {
      "methodLocalized": {
        "de_DE": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "en_US": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "ru_RU": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      },
      "currency": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "method": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "status": {
      "eq": "OPEN",
      "in": [
        "OPEN"
      ],
      "notEq": "OPEN"
    },
    "tenantOrderId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "tags": {
      "contains": {
        "value": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    }
  },
  "size": 1,
  "sort": [
    {
      "orderDate": "ASC",
      "status": "ASC"
    }
  ]
}

{
  "orders": [
    {
      "consumer": {
        "addresses": [
          {
            "additionalAddressInfo": "to care of: Mrs. Müller",
            "city": "Langenfeld",
            "country": "DE",
            "customAttributes": {},
            "houseNumber": "42a",
            "phoneNumbers": [
              {
                "customAttributes": {},
                "label": "text",
                "type": "MOBILE",
                "value": "text"
              }
            ],
            "postalCode": "40764",
            "province": "NRW",
            "street": "Hauptstr."
          }
        ],
        "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
        "customAttributes": {},
        "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
        "tenantFacilityId": "text"
      },
      "customAttributes": {},
      "customServices": [
        {
          "articleItems": [
            {
              "quantity": 1,
              "tenantArticleRef": "text"
            }
          ],
          "customServiceDefinition": {
            "additionalInformation": [
              {
                "additionalInformationRef": "text",
                "tenantAdditionalInformationId": "text",
                "value": "text"
              }
            ],
            "customAttributes": {},
            "customServiceRef": "text",
            "isBundled": true,
            "tenantCustomServiceId": "text"
          },
          "customServiceItems": "[Circular Reference]",
          "id": "text"
        }
      ],
      "deliveryPreferences": {
        "collect": [
          null
        ],
        "reservationPreferences": {
          "mode": "SCHEDULED",
          "reservationTime": "2020-02-03T09:45:51.525Z"
        },
        "shipping": {
          "carrierProductCategory": "STANDARD",
          "desiredDeliveryTime": "2020-02-03T09:45:51.525Z",
          "preferredCarriers": [
            "text"
          ],
          "preferredCarriersWithProduct": [],
          "preselectedFacilities": [
            null
          ],
          "serviceLevel": "DELIVERY"
        },
        "sourcingOptionRefs": [
          "928f3730-bc48-4d85-b83f-3fd86b776178"
        ],
        "supplyingFacilities": [
          "928f3730-bc48-4d85-b83f-3fd86b776178"
        ],
        "targetTime": "2020-02-03T09:45:51.525Z"
      },
      "orderDate": "2020-02-03T08:45:50.525Z",
      "orderLineItems": [
        {
          "allowedSubstitutes": [
            {
              "attributes": [
                {
                  "valueLocalized": {
                    "de_DE": "Wert",
                    "en_US": "Value",
                    "ru_RU": "значение"
                  },
                  "keyLocalized": {
                    "de_DE": "Wert",
                    "en_US": "Value",
                    "ru_RU": "значение"
                  },
                  "category": "descriptive",
                  "context": {
                    "type": "FACILITY_GROUP",
                    "value": "text"
                  },
                  "key": "%%subtitle%%",
                  "priority": 100,
                  "type": "STRING",
                  "value": "585er Gold"
                }
              ],
              "imageUrl": "text",
              "measurementUnitKey": "liter",
              "measurementValidation": {
                "overPickHardTolerancePercentage": 20,
                "overPickSoftTolerancePercentage": 15,
                "shortPickHardTolerancePercentage": 15,
                "shortPickSoftTolerancePercentage": 10
              },
              "priority": 1,
              "scannableCodes": [
                "text"
              ],
              "secondaryMeasurementUnitKey": "gram",
              "tenantArticleId": "text",
              "title": "text"
            }
          ],
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "customAttributes": {},
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "customAttributes": {},
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "quantity": 21,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "liter",
          "secondaryQuantity": 21,
          "shopPrice": 1200,
          "tags": [],
          "id": "LGMl2DuvPnfPoSHhYFOm"
        }
      ],
      "paymentInfo": {
        "methodLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "currency": "EUR",
        "method": "Credit Card"
      },
      "promisesOptions": {
        "validUntil": "2020-02-03T08:45:50.525Z"
      },
      "status": "OPEN",
      "statusReasons": [],
      "stickers": [],
      "tenantOrderId": "R456728546",
      "tags": [],
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "anonymized": false,
      "cancelationReason": {
        "action": "text",
        "id": "text",
        "reasonLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "reason": "Rerouted because of an issue in the Facility.",
        "created": "2020-02-03T08:45:51.525Z",
        "lastModified": "2020-02-03T09:45:51.525Z",
        "version": 42
      },
      "id": "LGMl2DuvPnfPoSHhYFOm",
      "processId": "text",
      "schemaVersion": 1,
      "updateDetails": [
        {
          "changes": {
            "consumer": {
              "addresses": [
                {
                  "additionalAddressInfo": "to care of: Mrs. Müller",
                  "city": "Langenfeld",
                  "country": "DE",
                  "customAttributes": {},
                  "houseNumber": "42a",
                  "phoneNumbers": [
                    {
                      "customAttributes": {},
                      "label": "text",
                      "type": "MOBILE",
                      "value": "text"
                    }
                  ],
                  "postalCode": "40764",
                  "province": "NRW",
                  "street": "Hauptstr."
                }
              ],
              "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
              "customAttributes": {},
              "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
              "tenantFacilityId": "text"
            },
            "customAttributes": {},
            "orderLineItems": [],
            "preferredHandlingTime": "2025-01-15T00:00:00.000Z"
          },
          "comment": "text",
          "created": "2020-02-03T08:45:50.525Z",
          "user": "text"
        }
      ]
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

Call order action

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orderIdstringRequired

Reference to the order you want to call the action for

Body

application/json

OrderActionsParameter

or

or

or

or

or

or

Responses

200

Updated Order in the body.

application/json

Order

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Order not found or expired

application/json

post

/api/orders/{orderId}/actions

HTTPcURLJavaScriptPython

POST /api/orders/{orderId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "name": "text",
  "targetTime": "2025-01-15T00:00:00.000Z",
  "version": 1
}

{
  "consumer": {
    "addresses": [
      {
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      }
    ],
    "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "customAttributes": {},
    "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "tenantFacilityId": "text"
  },
  "customAttributes": {},
  "customServices": [
    {
      "articleItems": [
        {
          "quantity": 1,
          "tenantArticleRef": "text"
        }
      ],
      "customServiceDefinition": {
        "additionalInformation": [
          {
            "additionalInformationRef": "text",
            "tenantAdditionalInformationId": "text",
            "value": "text"
          }
        ],
        "customAttributes": {},
        "customServiceRef": "text",
        "isBundled": true,
        "tenantCustomServiceId": "text"
      },
      "customServiceItems": [
        {}
      ],
      "id": "text"
    }
  ],
  "deliveryPreferences": {
    "collect": [
      null
    ],
    "reservationPreferences": {
      "mode": "SCHEDULED",
      "reservationTime": "2020-02-03T09:45:51.525Z"
    },
    "shipping": {
      "carrierProductCategory": "STANDARD",
      "desiredDeliveryTime": "2020-02-03T09:45:51.525Z",
      "preferredCarriers": [
        "text"
      ],
      "preferredCarriersWithProduct": [],
      "preselectedFacilities": [
        null
      ],
      "serviceLevel": "DELIVERY"
    },
    "sourcingOptionRefs": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "supplyingFacilities": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "targetTime": "2020-02-03T09:45:51.525Z"
  },
  "orderDate": "2020-02-03T08:45:50.525Z",
  "orderLineItems": [
    {
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "customAttributes": {},
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "liter",
      "secondaryQuantity": 21,
      "shopPrice": 1200,
      "tags": [],
      "id": "LGMl2DuvPnfPoSHhYFOm"
    }
  ],
  "paymentInfo": {
    "methodLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "currency": "EUR",
    "method": "Credit Card"
  },
  "promisesOptions": {
    "validUntil": "2020-02-03T08:45:50.525Z"
  },
  "status": "OPEN",
  "statusReasons": [],
  "stickers": [],
  "tenantOrderId": "R456728546",
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "cancelationReason": {
    "action": "text",
    "id": "text",
    "reasonLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "reason": "Rerouted because of an issue in the Facility.",
    "created": "2020-02-03T08:45:51.525Z",
    "lastModified": "2020-02-03T09:45:51.525Z",
    "version": 42
  },
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "processId": "text",
  "schemaVersion": 1,
  "updateDetails": [
    {
      "changes": {
        "consumer": {
          "addresses": [
            {
              "additionalAddressInfo": "to care of: Mrs. Müller",
              "city": "Langenfeld",
              "country": "DE",
              "customAttributes": {},
              "houseNumber": "42a",
              "phoneNumbers": [
                {
                  "customAttributes": {},
                  "label": "text",
                  "type": "MOBILE",
                  "value": "text"
                }
              ],
              "postalCode": "40764",
              "province": "NRW",
              "street": "Hauptstr."
            }
          ],
          "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
          "customAttributes": {},
          "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
          "tenantFacilityId": "text"
        },
        "customAttributes": {},
        "orderLineItems": [],
        "preferredHandlingTime": "2025-01-15T00:00:00.000Z"
      },
      "comment": "text",
      "created": "2020-02-03T08:45:50.525Z",
      "user": "text"
    }
  ]
}

Call order line item action

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orderIdstringRequired

Reference to the order you want to call the action for

orderLineItemIdstringRequired

Reference to the order line item you want to call the action for

Body

application/json

OrderLineItemActionsParameter

Responses

200

Updated Order in the body.

application/json

Order

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

/api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions

HTTPcURLJavaScriptPython

POST /api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "name": "text",
  "version": 1
}

{
  "consumer": {
    "addresses": [
      {
        "additionalAddressInfo": "to care of: Mrs. Müller",
        "city": "Langenfeld",
        "country": "DE",
        "customAttributes": {},
        "houseNumber": "42a",
        "phoneNumbers": [
          {
            "customAttributes": {},
            "label": "text",
            "type": "MOBILE",
            "value": "text"
          }
        ],
        "postalCode": "40764",
        "province": "NRW",
        "street": "Hauptstr."
      }
    ],
    "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "customAttributes": {},
    "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
    "tenantFacilityId": "text"
  },
  "customAttributes": {},
  "customServices": [
    {
      "articleItems": [
        {
          "quantity": 1,
          "tenantArticleRef": "text"
        }
      ],
      "customServiceDefinition": {
        "additionalInformation": [
          {
            "additionalInformationRef": "text",
            "tenantAdditionalInformationId": "text",
            "value": "text"
          }
        ],
        "customAttributes": {},
        "customServiceRef": "text",
        "isBundled": true,
        "tenantCustomServiceId": "text"
      },
      "customServiceItems": [
        {}
      ],
      "id": "text"
    }
  ],
  "deliveryPreferences": {
    "collect": [
      null
    ],
    "reservationPreferences": {
      "mode": "SCHEDULED",
      "reservationTime": "2020-02-03T09:45:51.525Z"
    },
    "shipping": {
      "carrierProductCategory": "STANDARD",
      "desiredDeliveryTime": "2020-02-03T09:45:51.525Z",
      "preferredCarriers": [
        "text"
      ],
      "preferredCarriersWithProduct": [],
      "preselectedFacilities": [
        null
      ],
      "serviceLevel": "DELIVERY"
    },
    "sourcingOptionRefs": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "supplyingFacilities": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "targetTime": "2020-02-03T09:45:51.525Z"
  },
  "orderDate": "2020-02-03T08:45:50.525Z",
  "orderLineItems": [
    {
      "allowedSubstitutes": [
        {
          "attributes": [
            {
              "valueLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "category": "descriptive",
              "context": {
                "type": "FACILITY_GROUP",
                "value": "text"
              },
              "key": "%%subtitle%%",
              "priority": 100,
              "type": "STRING",
              "value": "585er Gold"
            }
          ],
          "imageUrl": "text",
          "measurementUnitKey": "liter",
          "measurementValidation": {
            "overPickHardTolerancePercentage": 20,
            "overPickSoftTolerancePercentage": 15,
            "shortPickHardTolerancePercentage": 15,
            "shortPickSoftTolerancePercentage": 10
          },
          "priority": 1,
          "scannableCodes": [
            "text"
          ],
          "secondaryMeasurementUnitKey": "gram",
          "tenantArticleId": "text",
          "title": "text"
        }
      ],
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "customAttributes": {},
      "measurementUnitKey": "liter",
      "measurementValidation": {
        "overPickHardTolerancePercentage": 20,
        "overPickSoftTolerancePercentage": 15,
        "shortPickHardTolerancePercentage": 15,
        "shortPickSoftTolerancePercentage": 10
      },
      "quantity": 21,
      "scannableCodes": [
        "text"
      ],
      "secondaryMeasurementUnitKey": "liter",
      "secondaryQuantity": 21,
      "shopPrice": 1200,
      "tags": [],
      "id": "LGMl2DuvPnfPoSHhYFOm"
    }
  ],
  "paymentInfo": {
    "methodLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "currency": "EUR",
    "method": "Credit Card"
  },
  "promisesOptions": {
    "validUntil": "2020-02-03T08:45:50.525Z"
  },
  "status": "OPEN",
  "statusReasons": [],
  "stickers": [],
  "tenantOrderId": "R456728546",
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "anonymized": false,
  "cancelationReason": {
    "action": "text",
    "id": "text",
    "reasonLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "reason": "Rerouted because of an issue in the Facility.",
    "created": "2020-02-03T08:45:51.525Z",
    "lastModified": "2020-02-03T09:45:51.525Z",
    "version": 42
  },
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "processId": "text",
  "schemaVersion": 1,
  "updateDetails": [
    {
      "changes": {
        "consumer": {
          "addresses": [
            {
              "additionalAddressInfo": "to care of: Mrs. Müller",
              "city": "Langenfeld",
              "country": "DE",
              "customAttributes": {},
              "houseNumber": "42a",
              "phoneNumbers": [
                {
                  "customAttributes": {},
                  "label": "text",
                  "type": "MOBILE",
                  "value": "text"
                }
              ],
              "postalCode": "40764",
              "province": "NRW",
              "street": "Hauptstr."
            }
          ],
          "consumerId": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
          "customAttributes": {},
          "facilityRef": "e4213a07-f563-46a3-b1ba-4dfeb6abe82a",
          "tenantFacilityId": "text"
        },
        "customAttributes": {},
        "orderLineItems": [],
        "preferredHandlingTime": "2025-01-15T00:00:00.000Z"
      },
      "comment": "text",
      "created": "2020-02-03T08:45:50.525Z",
      "user": "text"
    }
  ]
}