Order records endpoints

List order records

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. List order records with pagination and optional filters

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

sizenumber · max: 500Optional

facilityRefstringOptional

tenantOrderRecordIdstringOptional

Responses

200

The order records that were found based on the given filters.

application/json

OrderRecords

totalnumberRequired

Total number of found entities for this query

Example: 42

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

application/json

get

/api/orderrecords

HTTPcURLJavaScriptPython

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

{
  "orderRecords": [
    {
      "anonymized": true,
      "consumer": {
        "addresses": [
          {
            "additionalAddressInfo": "text",
            "city": "text",
            "companyName": "text",
            "country": "text",
            "firstName": "text",
            "houseNumber": "text",
            "lastName": "text",
            "postalCode": "text",
            "province": "text",
            "street": "text"
          }
        ],
        "consumerId": "text",
        "email": "text"
      },
      "created": "2026-05-20T10:22:04.060Z",
      "customAttributes": {},
      "deletionDate": "2026-05-20T10:22:04.060Z",
      "facilityRef": "text",
      "gdprCleanupDate": "2026-05-20T10:22:04.060Z",
      "id": "text",
      "lastModified": "2026-05-20T10:22:04.060Z",
      "lineItems": [
        {
          "article": {
            "attributes": [
              {
                "valueLocalized": {},
                "keyLocalized": {},
                "category": "descriptive",
                "key": "text",
                "priority": 1,
                "type": "STRING",
                "value": "text"
              }
            ],
            "tenantArticleId": "text",
            "title": "text"
          },
          "customAttributes": {},
          "id": "text",
          "measurementUnitKey": "text",
          "quantity": 1,
          "returnPolicy": {
            "isReturnable": true,
            "returnWindowEndDate": "2026-05-20T10:22:04.060Z"
          },
          "warranty": {
            "warrantyPeriod": "text",
            "warrantyStartDate": "2026-05-20T10:22:04.060Z"
          }
        }
      ],
      "orderRecordDate": "2026-05-20T10:22:04.060Z",
      "origin": {
        "cashierId": "text",
        "terminalId": "text",
        "type": "POS"
      },
      "payments": [
        {
          "paymentMethod": "text",
          "receiptNumber": "text",
          "status": "COMPLETED",
          "taxValue": {
            "currency": "AED",
            "decimalPlaces": 1,
            "value": 1
          },
          "transactionId": "text",
          "value": {
            "currency": "AED",
            "decimalPlaces": 1,
            "value": 1
          }
        }
      ],
      "pricing": {
        "discounts": [
          {
            "nameLocalized": {},
            "code": "text",
            "context": "text",
            "name": "text",
            "tenantDiscountId": "text",
            "type": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 1,
              "value": 1
            }
          }
        ],
        "fees": [
          {
            "name": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 1,
              "value": 1
            }
          }
        ],
        "taxes": [
          {
            "ratePercent": 1,
            "scope": "text",
            "taxableValue": {
              "currency": "AED",
              "decimalPlaces": 1,
              "value": 1
            },
            "type": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 1,
              "value": 1
            }
          }
        ]
      },
      "tenantOrderRecordId": "text",
      "version": 1
    }
  ],
  "total": 42
}

Bulk create order records

put

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Create multiple order records in a single request (max 25)

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

OrderRecordBulkOperations

Responses

200

The order records have been successfully created.

application/json

OrderRecordBulkOperationsResponse

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

application/json

404

The requested entity was not found

application/json

put

/api/orderrecords

HTTPcURLJavaScriptPython

PUT /api/orderrecords HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1554

{
  "operations": [
    {
      "consumer": {
        "addresses": [
          {
            "additionalAddressInfo": "text",
            "city": "text",
            "companyName": "text",
            "country": "text",
            "firstName": "text",
            "houseNumber": "text",
            "lastName": "text",
            "postalCode": "text",
            "province": "text",
            "street": "text"
          }
        ],
        "consumerId": "text",
        "email": "text"
      },
      "customAttributes": {},
      "facilityRef": "text",
      "lineItems": [
        {
          "article": {
            "attributes": [
              {
                "valueLocalized": {},
                "keyLocalized": {},
                "category": "descriptive",
                "key": "text",
                "priority": 1,
                "type": "STRING",
                "value": "text"
              }
            ],
            "tenantArticleId": "text",
            "title": "text"
          },
          "customAttributes": {},
          "measurementUnitKey": "text",
          "quantity": 1,
          "returnPolicy": {
            "isReturnable": true,
            "returnWindowEndDate": "2026-05-20T10:22:04.060Z"
          },
          "warranty": {
            "warrantyPeriod": "text",
            "warrantyStartDate": "2026-05-20T10:22:04.060Z"
          }
        }
      ],
      "orderRecordDate": "2026-05-20T10:22:04.060Z",
      "origin": {
        "cashierId": "text",
        "terminalId": "text",
        "type": "POS"
      },
      "payments": [
        {
          "paymentMethod": "text",
          "receiptNumber": "text",
          "status": "COMPLETED",
          "taxValue": {
            "currency": "AED",
            "decimalPlaces": 1,
            "value": 1
          },
          "transactionId": "text",
          "value": {
            "currency": "AED",
            "decimalPlaces": 1,
            "value": 1
          }
        }
      ],
      "pricing": {
        "discounts": [
          {
            "nameLocalized": {},
            "code": "text",
            "context": "text",
            "name": "text",
            "tenantDiscountId": "text",
            "type": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 1,
              "value": 1
            }
          }
        ],
        "fees": [
          {
            "name": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 1,
              "value": 1
            }
          }
        ],
        "taxes": [
          {
            "ratePercent": 1,
            "scope": "text",
            "taxableValue": {
              "currency": "AED",
              "decimalPlaces": 1,
              "value": 1
            },
            "type": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 1,
              "value": 1
            }
          }
        ]
      },
      "tenantOrderRecordId": "text"
    }
  ]
}

{
  "details": [
    {
      "error": {
        "message": "text",
        "type": "VALIDATION"
      },
      "orderRecord": {
        "anonymized": true,
        "consumer": {
          "addresses": [
            {
              "additionalAddressInfo": "text",
              "city": "text",
              "companyName": "text",
              "country": "text",
              "firstName": "text",
              "houseNumber": "text",
              "lastName": "text",
              "postalCode": "text",
              "province": "text",
              "street": "text"
            }
          ],
          "consumerId": "text",
          "email": "text"
        },
        "created": "2026-05-20T10:22:04.060Z",
        "customAttributes": {},
        "deletionDate": "2026-05-20T10:22:04.060Z",
        "facilityRef": "text",
        "gdprCleanupDate": "2026-05-20T10:22:04.060Z",
        "id": "text",
        "lastModified": "2026-05-20T10:22:04.060Z",
        "lineItems": [
          {
            "article": {
              "attributes": [
                {
                  "valueLocalized": {},
                  "keyLocalized": {},
                  "category": "descriptive",
                  "key": "text",
                  "priority": 1,
                  "type": "STRING",
                  "value": "text"
                }
              ],
              "tenantArticleId": "text",
              "title": "text"
            },
            "customAttributes": {},
            "id": "text",
            "measurementUnitKey": "text",
            "quantity": 1,
            "returnPolicy": {
              "isReturnable": true,
              "returnWindowEndDate": "2026-05-20T10:22:04.060Z"
            },
            "warranty": {
              "warrantyPeriod": "text",
              "warrantyStartDate": "2026-05-20T10:22:04.060Z"
            }
          }
        ],
        "orderRecordDate": "2026-05-20T10:22:04.060Z",
        "origin": {
          "cashierId": "text",
          "terminalId": "text",
          "type": "POS"
        },
        "payments": [
          {
            "paymentMethod": "text",
            "receiptNumber": "text",
            "status": "COMPLETED",
            "taxValue": {
              "currency": "AED",
              "decimalPlaces": 1,
              "value": 1
            },
            "transactionId": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 1,
              "value": 1
            }
          }
        ],
        "pricing": {
          "discounts": [
            {
              "nameLocalized": {},
              "code": "text",
              "context": "text",
              "name": "text",
              "tenantDiscountId": "text",
              "type": "text",
              "value": {
                "currency": "AED",
                "decimalPlaces": 1,
                "value": 1
              }
            }
          ],
          "fees": [
            {
              "name": "text",
              "value": {
                "currency": "AED",
                "decimalPlaces": 1,
                "value": 1
              }
            }
          ],
          "taxes": [
            {
              "ratePercent": 1,
              "scope": "text",
              "taxableValue": {
                "currency": "AED",
                "decimalPlaces": 1,
                "value": 1
              },
              "type": "text",
              "value": {
                "currency": "AED",
                "decimalPlaces": 1,
                "value": 1
              }
            }
          ]
        },
        "tenantOrderRecordId": "text",
        "version": 1
      },
      "status": "CREATED"
    }
  ],
  "summary": {
    "created": 1,
    "unchanged": 1,
    "updated": 1
  }
}

Get an order record

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Get a single order record by id

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orderRecordIdstringRequired

Responses

200

The order record was found.

application/json

OrderRecord

anonymizedbooleanRequired

Whether consumer data has been anonymized

createdstring · date-timeRequired

Creation timestamp

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

deletionDatestring · date-timeRequired

Date when the record will be deleted

facilityRefstringRequired

Reference to the facility

gdprCleanupDatestring · date-timeRequired

Date when GDPR cleanup will occur

idstringRequired

Unique identifier of the order record

lastModifiedstring · date-timeRequired

Last modification timestamp

orderRecordDatestring · date-timeRequired

Date of the order record

tenantOrderRecordIdstringOptional

Tenant-specific order record identifier

versionintegerRequired

Version number for optimistic locking

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

404

The requested entity was not found

application/json

get

/api/orderrecords/{orderRecordId}

HTTPcURLJavaScriptPython

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

{
  "anonymized": true,
  "consumer": {
    "addresses": [
      {
        "additionalAddressInfo": "text",
        "city": "text",
        "companyName": "text",
        "country": "text",
        "firstName": "text",
        "houseNumber": "text",
        "lastName": "text",
        "postalCode": "text",
        "province": "text",
        "street": "text"
      }
    ],
    "consumerId": "text",
    "email": "text"
  },
  "created": "2026-05-20T10:22:04.060Z",
  "customAttributes": {},
  "deletionDate": "2026-05-20T10:22:04.060Z",
  "facilityRef": "text",
  "gdprCleanupDate": "2026-05-20T10:22:04.060Z",
  "id": "text",
  "lastModified": "2026-05-20T10:22:04.060Z",
  "lineItems": [
    {
      "article": {
        "attributes": [
          {
            "valueLocalized": {},
            "keyLocalized": {},
            "category": "descriptive",
            "key": "text",
            "priority": 1,
            "type": "STRING",
            "value": "text"
          }
        ],
        "tenantArticleId": "text",
        "title": "text"
      },
      "customAttributes": {},
      "id": "text",
      "measurementUnitKey": "text",
      "quantity": 1,
      "returnPolicy": {
        "isReturnable": true,
        "returnWindowEndDate": "2026-05-20T10:22:04.060Z"
      },
      "warranty": {
        "warrantyPeriod": "text",
        "warrantyStartDate": "2026-05-20T10:22:04.060Z"
      }
    }
  ],
  "orderRecordDate": "2026-05-20T10:22:04.060Z",
  "origin": {
    "cashierId": "text",
    "terminalId": "text",
    "type": "POS"
  },
  "payments": [
    {
      "paymentMethod": "text",
      "receiptNumber": "text",
      "status": "COMPLETED",
      "taxValue": {
        "currency": "AED",
        "decimalPlaces": 1,
        "value": 1
      },
      "transactionId": "text",
      "value": {
        "currency": "AED",
        "decimalPlaces": 1,
        "value": 1
      }
    }
  ],
  "pricing": {
    "discounts": [
      {
        "nameLocalized": {},
        "code": "text",
        "context": "text",
        "name": "text",
        "tenantDiscountId": "text",
        "type": "text",
        "value": {
          "currency": "AED",
          "decimalPlaces": 1,
          "value": 1
        }
      }
    ],
    "fees": [
      {
        "name": "text",
        "value": {
          "currency": "AED",
          "decimalPlaces": 1,
          "value": 1
        }
      }
    ],
    "taxes": [
      {
        "ratePercent": 1,
        "scope": "text",
        "taxableValue": {
          "currency": "AED",
          "decimalPlaces": 1,
          "value": 1
        },
        "type": "text",
        "value": {
          "currency": "AED",
          "decimalPlaces": 1,
          "value": 1
        }
      }
    ]
  },
  "tenantOrderRecordId": "text",
  "version": 1
}