Order Records (DOMS)

Endpoints for managing orders that have already been completed and do not need to participate in the fulfillment lifecycle.

Get order records configuration

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Get the current configuration for the order records functionality

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The order records configuration

application/json

This part of the API is in Alpha status. For details, see the API release lifecycle documentation.

Configuration for the order records functionality.

createdstring · date-timeOptional

Creation timestamp.

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

idstringRequired

Unique identifier of the order record config.

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

isOrderRecordsEnabledbooleanRequired

Flag indicating whether order records functionality is enabled.

Default: false

lastModifiedstring · date-timeOptional

Last modification timestamp.

Example: 2026-06-17T12:00:00.000Z

versioninteger · int64Required

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

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/configurations/orderrecords

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

{
  "created": "2020-02-03T08:45:50.525Z",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "isOrderRecordsEnabled": false,
  "lastModified": "2026-06-17T12:00:00.000Z",
  "version": 42
}

Create or update order records configuration

put

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Create or update the configuration for the order records functionality.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

OrderRecordsConfigurationInput

isOrderRecordsEnabledbooleanRequired

Flag indicating whether order records functionality is enabled.

Default: false

versioninteger · int64Required

Version number for optimistic locking.

Example: 1

Responses

200

The updated order records configuration

application/json

This part of the API is in Alpha status. For details, see the API release lifecycle documentation.

Configuration for the order records functionality.

createdstring · date-timeOptional

Creation timestamp.

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

idstringRequired

Unique identifier of the order record config.

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

isOrderRecordsEnabledbooleanRequired

Flag indicating whether order records functionality is enabled.

Default: false

lastModifiedstring · date-timeOptional

Last modification timestamp.

Example: 2026-06-17T12:00:00.000Z

versioninteger · int64Required

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

Example: 42

201

The created order records configuration

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

put/api/configurations/orderrecords

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

{
  "isOrderRecordsEnabled": false,
  "version": 1
}

{
  "created": "2020-02-03T08:45:50.525Z",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "isOrderRecordsEnabled": false,
  "lastModified": "2026-06-17T12:00:00.000Z",
  "version": 42
}

List order records

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation. List order records with pagination and optional filters

Authorizations

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 endpoint

application/json

get/api/orderrecords

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": "Yellowstone",
            "companyName": "text",
            "country": "US",
            "firstName": "text",
            "houseNumber": 42,
            "lastName": "text",
            "postalCode": "42420",
            "province": "text",
            "street": "text"
          }
        ],
        "consumerId": "text",
        "email": "[e-mail]"
      },
      "created": "2026-06-17T12:00:00.000Z",
      "customAttributes": {},
      "deletionDate": "2026-06-17T12:00:00.000Z",
      "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "gdprCleanupDate": "2026-06-17T12:00:00.000Z",
      "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "lastModified": "2026-06-17T12:00:00.000Z",
      "lineItems": [
        {
          "article": {
            "attributes": [
              {
                "valueLocalized": {},
                "keyLocalized": {},
                "category": "descriptive",
                "key": "text",
                "priority": 42,
                "type": "STRING",
                "value": "text"
              }
            ],
            "tenantArticleId": "MY_ARTICLE_ID",
            "title": "text"
          },
          "customAttributes": {},
          "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
          "measurementUnitKey": "text",
          "quantity": 42,
          "returnPolicy": {
            "isReturnable": true,
            "returnWindowEndDate": "2026-06-17T12:00:00.000Z"
          },
          "warranty": {
            "warrantyPeriod": "text",
            "warrantyStartDate": "2026-06-17T12:00:00.000Z"
          }
        }
      ],
      "orderRecordDate": "2026-06-17T12:00:00.000Z",
      "origin": {
        "cashierId": "text",
        "terminalId": "text",
        "type": "POS"
      },
      "payments": [
        {
          "paymentMethod": "text",
          "receiptNumber": "text",
          "status": "COMPLETED",
          "taxValue": {
            "currency": "AED",
            "decimalPlaces": 42,
            "value": 42
          },
          "transactionId": "text",
          "value": {
            "currency": "AED",
            "decimalPlaces": 42,
            "value": 42
          }
        }
      ],
      "pricing": {
        "discounts": [
          {
            "nameLocalized": {},
            "code": "text",
            "context": "text",
            "name": "text",
            "percentage": 1,
            "tenantDiscountId": "MY_DISCOUNT_ID",
            "type": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            }
          }
        ],
        "fees": [
          {
            "name": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            }
          }
        ],
        "taxes": [
          {
            "ratePercent": 42,
            "scope": "text",
            "taxableValue": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            },
            "type": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            }
          }
        ],
        "total": {
          "priceBreakdown": {
            "subTotal": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            },
            "total": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            },
            "totalDiscounts": {
              "breakdown": {
                "lineItemDiscounts": {
                  "currency": "AED",
                  "decimalPlaces": 42,
                  "value": 42
                },
                "orderDiscounts": {
                  "currency": "AED",
                  "decimalPlaces": 42,
                  "value": 42
                }
              },
              "value": {
                "currency": "AED",
                "decimalPlaces": 42,
                "value": 42
              }
            },
            "totalFees": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            },
            "totalLineItemSurcharges": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            },
            "totalTaxes": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            }
          }
        }
      },
      "tenantOrderRecordId": "MY_ORDERRECORD_ID",
      "version": 1
    }
  ],
  "total": 42
}

Bulk create order records

put

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Create multiple order records in a single request (max 25)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

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 endpoint

application/json

404

The requested entity was not found

application/json

put/api/orderrecords

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: 1677

{
  "operations": [
    {
      "consumer": {
        "addresses": [
          {
            "additionalAddressInfo": "text",
            "city": "Yellowstone",
            "companyName": "text",
            "country": "US",
            "firstName": "text",
            "houseNumber": 42,
            "lastName": "text",
            "postalCode": "42420",
            "province": "text",
            "street": "text"
          }
        ],
        "consumerId": "text",
        "email": "[e-mail]"
      },
      "customAttributes": {},
      "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "lineItems": [
        {
          "article": {
            "attributes": [
              {
                "valueLocalized": {},
                "keyLocalized": {},
                "category": "descriptive",
                "key": "text",
                "priority": 42,
                "type": "STRING",
                "value": "text"
              }
            ],
            "tenantArticleId": "MY_ARTICLE_ID",
            "title": "text"
          },
          "customAttributes": {},
          "measurementUnitKey": "text",
          "quantity": 42,
          "returnPolicy": {
            "isReturnable": true,
            "returnWindowEndDate": "2026-06-17T12:00:00.000Z"
          },
          "warranty": {
            "warrantyPeriod": "text",
            "warrantyStartDate": "2026-06-17T12:00:00.000Z"
          }
        }
      ],
      "orderRecordDate": "2026-06-17T12:00:00.000Z",
      "origin": {
        "cashierId": "text",
        "terminalId": "text",
        "type": "POS"
      },
      "payments": [
        {
          "paymentMethod": "text",
          "receiptNumber": "text",
          "status": "COMPLETED",
          "taxValue": {
            "currency": "AED",
            "decimalPlaces": 42,
            "value": 42
          },
          "transactionId": "text",
          "value": {
            "currency": "AED",
            "decimalPlaces": 42,
            "value": 42
          }
        }
      ],
      "pricing": {
        "discounts": [
          {
            "nameLocalized": {},
            "code": "text",
            "context": "text",
            "name": "text",
            "percentage": 1,
            "tenantDiscountId": "MY_DISCOUNT_ID",
            "type": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            }
          }
        ],
        "fees": [
          {
            "name": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            }
          }
        ],
        "taxes": [
          {
            "ratePercent": 42,
            "scope": "text",
            "taxableValue": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            },
            "type": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            }
          }
        ]
      },
      "tenantOrderRecordId": "MY_ORDERRECORD_ID"
    }
  ]
}

{
  "details": [
    {
      "error": {
        "message": "text",
        "type": "VALIDATION"
      },
      "orderRecord": {
        "anonymized": true,
        "consumer": {
          "addresses": [
            {
              "additionalAddressInfo": "text",
              "city": "Yellowstone",
              "companyName": "text",
              "country": "US",
              "firstName": "text",
              "houseNumber": 42,
              "lastName": "text",
              "postalCode": "42420",
              "province": "text",
              "street": "text"
            }
          ],
          "consumerId": "text",
          "email": "[e-mail]"
        },
        "created": "2026-06-17T12:00:00.000Z",
        "customAttributes": {},
        "deletionDate": "2026-06-17T12:00:00.000Z",
        "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "gdprCleanupDate": "2026-06-17T12:00:00.000Z",
        "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "lastModified": "2026-06-17T12:00:00.000Z",
        "lineItems": [
          {
            "article": {
              "attributes": [
                {
                  "valueLocalized": {},
                  "keyLocalized": {},
                  "category": "descriptive",
                  "key": "text",
                  "priority": 42,
                  "type": "STRING",
                  "value": "text"
                }
              ],
              "tenantArticleId": "MY_ARTICLE_ID",
              "title": "text"
            },
            "customAttributes": {},
            "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
            "measurementUnitKey": "text",
            "quantity": 42,
            "returnPolicy": {
              "isReturnable": true,
              "returnWindowEndDate": "2026-06-17T12:00:00.000Z"
            },
            "warranty": {
              "warrantyPeriod": "text",
              "warrantyStartDate": "2026-06-17T12:00:00.000Z"
            }
          }
        ],
        "orderRecordDate": "2026-06-17T12:00:00.000Z",
        "origin": {
          "cashierId": "text",
          "terminalId": "text",
          "type": "POS"
        },
        "payments": [
          {
            "paymentMethod": "text",
            "receiptNumber": "text",
            "status": "COMPLETED",
            "taxValue": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            },
            "transactionId": "text",
            "value": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            }
          }
        ],
        "pricing": {
          "discounts": [
            {
              "nameLocalized": {},
              "code": "text",
              "context": "text",
              "name": "text",
              "percentage": 1,
              "tenantDiscountId": "MY_DISCOUNT_ID",
              "type": "text",
              "value": {
                "currency": "AED",
                "decimalPlaces": 42,
                "value": 42
              }
            }
          ],
          "fees": [
            {
              "name": "text",
              "value": {
                "currency": "AED",
                "decimalPlaces": 42,
                "value": 42
              }
            }
          ],
          "taxes": [
            {
              "ratePercent": 42,
              "scope": "text",
              "taxableValue": {
                "currency": "AED",
                "decimalPlaces": 42,
                "value": 42
              },
              "type": "text",
              "value": {
                "currency": "AED",
                "decimalPlaces": 42,
                "value": 42
              }
            }
          ],
          "total": {
            "priceBreakdown": {
              "subTotal": {
                "currency": "AED",
                "decimalPlaces": 42,
                "value": 42
              },
              "total": {
                "currency": "AED",
                "decimalPlaces": 42,
                "value": 42
              },
              "totalDiscounts": {
                "breakdown": {
                  "lineItemDiscounts": {
                    "currency": "AED",
                    "decimalPlaces": 42,
                    "value": 42
                  },
                  "orderDiscounts": {
                    "currency": "AED",
                    "decimalPlaces": 42,
                    "value": 42
                  }
                },
                "value": {
                  "currency": "AED",
                  "decimalPlaces": 42,
                  "value": 42
                }
              },
              "totalFees": {
                "currency": "AED",
                "decimalPlaces": 42,
                "value": 42
              },
              "totalLineItemSurcharges": {
                "currency": "AED",
                "decimalPlaces": 42,
                "value": 42
              },
              "totalTaxes": {
                "currency": "AED",
                "decimalPlaces": 42,
                "value": 42
              }
            }
          }
        },
        "tenantOrderRecordId": "MY_ORDERRECORD_ID",
        "version": 1
      },
      "status": "CREATED"
    }
  ],
  "summary": {
    "created": 42,
    "unchanged": 42,
    "updated": "2026-06-17T12:00:00.000Z"
  }
}

Get an order record

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Get a single order record by id

Authorizations

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

Example: 2026-06-17T12:00:00.000Z

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

Example: 2026-06-17T12:00:00.000Z

facilityRefstringRequired

Reference to the facility

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

gdprCleanupDatestring · date-timeRequired

Date when GDPR cleanup will occur

Example: 2026-06-17T12:00:00.000Z

idstringRequired

Unique identifier of the order record

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

lastModifiedstring · date-timeRequired

Last modification timestamp

Example: 2026-06-17T12:00:00.000Z

orderRecordDatestring · date-timeRequired

Date of the order record

Example: 2026-06-17T12:00:00.000Z

tenantOrderRecordIdstringOptional

Tenant-specific order record identifier

Example: MY_ORDERRECORD_ID

versionintegerRequired

Version number for optimistic locking

Example: 1

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

The requested entity was not found

application/json

get/api/orderrecords/{orderRecordId}

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": "Yellowstone",
        "companyName": "text",
        "country": "US",
        "firstName": "text",
        "houseNumber": 42,
        "lastName": "text",
        "postalCode": "42420",
        "province": "text",
        "street": "text"
      }
    ],
    "consumerId": "text",
    "email": "[e-mail]"
  },
  "created": "2026-06-17T12:00:00.000Z",
  "customAttributes": {},
  "deletionDate": "2026-06-17T12:00:00.000Z",
  "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "gdprCleanupDate": "2026-06-17T12:00:00.000Z",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastModified": "2026-06-17T12:00:00.000Z",
  "lineItems": [
    {
      "article": {
        "attributes": [
          {
            "valueLocalized": {},
            "keyLocalized": {},
            "category": "descriptive",
            "key": "text",
            "priority": 42,
            "type": "STRING",
            "value": "text"
          }
        ],
        "tenantArticleId": "MY_ARTICLE_ID",
        "title": "text"
      },
      "customAttributes": {},
      "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "measurementUnitKey": "text",
      "quantity": 42,
      "returnPolicy": {
        "isReturnable": true,
        "returnWindowEndDate": "2026-06-17T12:00:00.000Z"
      },
      "warranty": {
        "warrantyPeriod": "text",
        "warrantyStartDate": "2026-06-17T12:00:00.000Z"
      }
    }
  ],
  "orderRecordDate": "2026-06-17T12:00:00.000Z",
  "origin": {
    "cashierId": "text",
    "terminalId": "text",
    "type": "POS"
  },
  "payments": [
    {
      "paymentMethod": "text",
      "receiptNumber": "text",
      "status": "COMPLETED",
      "taxValue": {
        "currency": "AED",
        "decimalPlaces": 42,
        "value": 42
      },
      "transactionId": "text",
      "value": {
        "currency": "AED",
        "decimalPlaces": 42,
        "value": 42
      }
    }
  ],
  "pricing": {
    "discounts": [
      {
        "nameLocalized": {},
        "code": "text",
        "context": "text",
        "name": "text",
        "percentage": 1,
        "tenantDiscountId": "MY_DISCOUNT_ID",
        "type": "text",
        "value": {
          "currency": "AED",
          "decimalPlaces": 42,
          "value": 42
        }
      }
    ],
    "fees": [
      {
        "name": "text",
        "value": {
          "currency": "AED",
          "decimalPlaces": 42,
          "value": 42
        }
      }
    ],
    "taxes": [
      {
        "ratePercent": 42,
        "scope": "text",
        "taxableValue": {
          "currency": "AED",
          "decimalPlaces": 42,
          "value": 42
        },
        "type": "text",
        "value": {
          "currency": "AED",
          "decimalPlaces": 42,
          "value": 42
        }
      }
    ],
    "total": {
      "priceBreakdown": {
        "subTotal": {
          "currency": "AED",
          "decimalPlaces": 42,
          "value": 42
        },
        "total": {
          "currency": "AED",
          "decimalPlaces": 42,
          "value": 42
        },
        "totalDiscounts": {
          "breakdown": {
            "lineItemDiscounts": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            },
            "orderDiscounts": {
              "currency": "AED",
              "decimalPlaces": 42,
              "value": 42
            }
          },
          "value": {
            "currency": "AED",
            "decimalPlaces": 42,
            "value": 42
          }
        },
        "totalFees": {
          "currency": "AED",
          "decimalPlaces": 42,
          "value": 42
        },
        "totalLineItemSurcharges": {
          "currency": "AED",
          "decimalPlaces": 42,
          "value": 42
        },
        "totalTaxes": {
          "currency": "AED",
          "decimalPlaces": 42,
          "value": 42
        }
      }
    }
  },
  "tenantOrderRecordId": "MY_ORDERRECORD_ID",
  "version": 1
}