> For the complete documentation index, see [llms.txt](https://docs.fulfillmenttools.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fulfillmenttools.com/documentation/by-pillar/availability-and-promising/external-information-lookup/external-lookup-endpoints.md).
# External lookup endpoints
## The LookupRecord object
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"components":{"schemas":{"LookupRecord":{"properties":{"attributeDefinitions":{"allOf":[{"$ref":"#/components/schemas/LookupAttributeDefinitions"}],"description":"Map of attribute definitions that specify the type for each attribute."},"created":{"description":"The date when the record was created.","format":"date-time","type":"string"},"id":{"type":"string"},"items":{"description":"Collection of items in the lookup record, each containing attribute values.","items":{"$ref":"#/components/schemas/LookupRecordItemStripped"},"type":"array"},"lastModified":{"description":"The date when the record was last modified.","format":"date-time","type":"string"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"},"version":{"description":"The version of the record.","type":"number"}},"required":["id","version","attributeDefinitions","items"],"title":"LookupRecord","type":"object","description":"LookupRecord"},"LookupAttributeDefinitions":{"properties":{},"title":"LookupAttributeDefinitions","type":"object","description":"LookupAttributeDefinitions"},"LookupRecordItemStripped":{"properties":{"id":{"description":"Unique identifier for the lookup record item.","type":"string"},"values":{"description":"Array of attribute-value pairs for the lookup record item.","items":{"$ref":"#/components/schemas/LookupRecordItemValue"},"type":"array"}},"required":["values","id"],"title":"LookupRecordItemStripped","type":"object","description":"LookupRecordItemStripped"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"}}}}
```
## Get a lookup record by its ID
> Retrieves a single lookup record using its unique identifier.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints used by shops to get the current available pickup stores and available service levels like Same-Day delivery.","name":"Checkout Options (DOMS)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LookupRecord":{"properties":{"attributeDefinitions":{"allOf":[{"$ref":"#/components/schemas/LookupAttributeDefinitions"}],"description":"Map of attribute definitions that specify the type for each attribute."},"created":{"description":"The date when the record was created.","format":"date-time","type":"string"},"id":{"type":"string"},"items":{"description":"Collection of items in the lookup record, each containing attribute values.","items":{"$ref":"#/components/schemas/LookupRecordItemStripped"},"type":"array"},"lastModified":{"description":"The date when the record was last modified.","format":"date-time","type":"string"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"},"version":{"description":"The version of the record.","type":"number"}},"required":["id","version","attributeDefinitions","items"],"title":"LookupRecord","type":"object","description":"LookupRecord"},"LookupAttributeDefinitions":{"properties":{},"title":"LookupAttributeDefinitions","type":"object","description":"LookupAttributeDefinitions"},"LookupRecordItemStripped":{"properties":{"id":{"description":"Unique identifier for the lookup record item.","type":"string"},"values":{"description":"Array of attribute-value pairs for the lookup record item.","items":{"$ref":"#/components/schemas/LookupRecordItemValue"},"type":"array"}},"required":["values","id"],"title":"LookupRecordItemStripped","type":"object","description":"LookupRecordItemStripped"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/lookuprecords/{recordId}":{"get":{"deprecated":false,"description":"Retrieves a single lookup record using its unique identifier.","operationId":"getLookupRecord","parameters":[{"in":"path","name":"recordId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupRecord"}}},"description":"Successfully retrieved the lookup record."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get a lookup record by its ID","tags":["Checkout Options (DOMS)"]}}}}
```
## Updates a whole lookup record by its ID
> Updates a single lookup record.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints used by shops to get the current available pickup stores and available service levels like Same-Day delivery.","name":"Checkout Options (DOMS)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LookupRecordForUpdate":{"properties":{"attributeDefinitions":{"allOf":[{"$ref":"#/components/schemas/LookupAttributeDefinitions"}],"description":"Map of attribute definitions that specify the type for each attribute."},"items":{"description":"Collection of items in the lookup record, each containing attribute values.","items":{"$ref":"#/components/schemas/LookupRecordItemForCreation"},"type":"array"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"},"version":{"description":"The version of the record.","type":"number"}},"required":["version","attributeDefinitions","items"],"title":"LookupRecordForUpdate","type":"object","description":"LookupRecordForUpdate"},"LookupAttributeDefinitions":{"properties":{},"title":"LookupAttributeDefinitions","type":"object","description":"LookupAttributeDefinitions"},"LookupRecordItemForCreation":{"properties":{"values":{"description":"Array of attribute-value pairs for the lookup record item.","items":{"$ref":"#/components/schemas/LookupRecordItemValue"},"type":"array"}},"required":["values"],"title":"LookupRecordItemForCreation","type":"object","description":"LookupRecordItemForCreation"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"},"LookupRecord":{"properties":{"attributeDefinitions":{"allOf":[{"$ref":"#/components/schemas/LookupAttributeDefinitions"}],"description":"Map of attribute definitions that specify the type for each attribute."},"created":{"description":"The date when the record was created.","format":"date-time","type":"string"},"id":{"type":"string"},"items":{"description":"Collection of items in the lookup record, each containing attribute values.","items":{"$ref":"#/components/schemas/LookupRecordItemStripped"},"type":"array"},"lastModified":{"description":"The date when the record was last modified.","format":"date-time","type":"string"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"},"version":{"description":"The version of the record.","type":"number"}},"required":["id","version","attributeDefinitions","items"],"title":"LookupRecord","type":"object","description":"LookupRecord"},"LookupRecordItemStripped":{"properties":{"id":{"description":"Unique identifier for the lookup record item.","type":"string"},"values":{"description":"Array of attribute-value pairs for the lookup record item.","items":{"$ref":"#/components/schemas/LookupRecordItemValue"},"type":"array"}},"required":["values","id"],"title":"LookupRecordItemStripped","type":"object","description":"LookupRecordItemStripped"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/lookuprecords/{recordId}":{"put":{"deprecated":false,"description":"Updates a single lookup record.","operationId":"putLookupRecord","parameters":[{"in":"path","name":"recordId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupRecordForUpdate"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupRecord"}}},"description":"Successfully updated the lookup record."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Updates a whole lookup record by its ID","tags":["Checkout Options (DOMS)"]}}}}
```
## Get all lookup records
> Retrieves all lookup records.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints used by shops to get the current available pickup stores and available service levels like Same-Day delivery.","name":"Checkout Options (DOMS)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LookupRecord":{"properties":{"attributeDefinitions":{"allOf":[{"$ref":"#/components/schemas/LookupAttributeDefinitions"}],"description":"Map of attribute definitions that specify the type for each attribute."},"created":{"description":"The date when the record was created.","format":"date-time","type":"string"},"id":{"type":"string"},"items":{"description":"Collection of items in the lookup record, each containing attribute values.","items":{"$ref":"#/components/schemas/LookupRecordItemStripped"},"type":"array"},"lastModified":{"description":"The date when the record was last modified.","format":"date-time","type":"string"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"},"version":{"description":"The version of the record.","type":"number"}},"required":["id","version","attributeDefinitions","items"],"title":"LookupRecord","type":"object","description":"LookupRecord"},"LookupAttributeDefinitions":{"properties":{},"title":"LookupAttributeDefinitions","type":"object","description":"LookupAttributeDefinitions"},"LookupRecordItemStripped":{"properties":{"id":{"description":"Unique identifier for the lookup record item.","type":"string"},"values":{"description":"Array of attribute-value pairs for the lookup record item.","items":{"$ref":"#/components/schemas/LookupRecordItemValue"},"type":"array"}},"required":["values","id"],"title":"LookupRecordItemStripped","type":"object","description":"LookupRecordItemStripped"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/lookuprecords":{"get":{"deprecated":false,"description":"Retrieves all lookup records.","operationId":"getAllLookupRecords","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupRecord"}}},"description":"Successfully retrieved the lookup records."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get all lookup records","tags":["Checkout Options (DOMS)"]}}}}
```
## Create a lookup record by its ID
> Creates a single lookup record.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints used by shops to get the current available pickup stores and available service levels like Same-Day delivery.","name":"Checkout Options (DOMS)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LookupRecordForCreation":{"properties":{"attributeDefinitions":{"allOf":[{"$ref":"#/components/schemas/LookupAttributeDefinitions"}],"description":"Map of attribute definitions that specify the type for each attribute."},"items":{"description":"Collection of items in the lookup record, each containing attribute values.","items":{"$ref":"#/components/schemas/LookupRecordItemForCreation"},"type":"array"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"}},"required":["attributeDefinitions","items"],"title":"LookupRecordForCreation","type":"object","description":"LookupRecordForCreation"},"LookupAttributeDefinitions":{"properties":{},"title":"LookupAttributeDefinitions","type":"object","description":"LookupAttributeDefinitions"},"LookupRecordItemForCreation":{"properties":{"values":{"description":"Array of attribute-value pairs for the lookup record item.","items":{"$ref":"#/components/schemas/LookupRecordItemValue"},"type":"array"}},"required":["values"],"title":"LookupRecordItemForCreation","type":"object","description":"LookupRecordItemForCreation"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"},"LookupRecord":{"properties":{"attributeDefinitions":{"allOf":[{"$ref":"#/components/schemas/LookupAttributeDefinitions"}],"description":"Map of attribute definitions that specify the type for each attribute."},"created":{"description":"The date when the record was created.","format":"date-time","type":"string"},"id":{"type":"string"},"items":{"description":"Collection of items in the lookup record, each containing attribute values.","items":{"$ref":"#/components/schemas/LookupRecordItemStripped"},"type":"array"},"lastModified":{"description":"The date when the record was last modified.","format":"date-time","type":"string"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"},"version":{"description":"The version of the record.","type":"number"}},"required":["id","version","attributeDefinitions","items"],"title":"LookupRecord","type":"object","description":"LookupRecord"},"LookupRecordItemStripped":{"properties":{"id":{"description":"Unique identifier for the lookup record item.","type":"string"},"values":{"description":"Array of attribute-value pairs for the lookup record item.","items":{"$ref":"#/components/schemas/LookupRecordItemValue"},"type":"array"}},"required":["values","id"],"title":"LookupRecordItemStripped","type":"object","description":"LookupRecordItemStripped"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/lookuprecords":{"post":{"deprecated":false,"description":"Creates a single lookup record.","operationId":"createLookupRecord","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupRecordForCreation"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupRecord"}}},"description":"Successfully created the lookup record."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Create a lookup record by its ID","tags":["Checkout Options (DOMS)"]}}}}
```
## Delete a lookup record by its ID
> Deletes a single lookup record using its unique identifier.
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints used by shops to get the current available pickup stores and available service levels like Same-Day delivery.","name":"Checkout Options (DOMS)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LookupRecord":{"properties":{"attributeDefinitions":{"allOf":[{"$ref":"#/components/schemas/LookupAttributeDefinitions"}],"description":"Map of attribute definitions that specify the type for each attribute."},"created":{"description":"The date when the record was created.","format":"date-time","type":"string"},"id":{"type":"string"},"items":{"description":"Collection of items in the lookup record, each containing attribute values.","items":{"$ref":"#/components/schemas/LookupRecordItemStripped"},"type":"array"},"lastModified":{"description":"The date when the record was last modified.","format":"date-time","type":"string"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"},"version":{"description":"The version of the record.","type":"number"}},"required":["id","version","attributeDefinitions","items"],"title":"LookupRecord","type":"object","description":"LookupRecord"},"LookupAttributeDefinitions":{"properties":{},"title":"LookupAttributeDefinitions","type":"object","description":"LookupAttributeDefinitions"},"LookupRecordItemStripped":{"properties":{"id":{"description":"Unique identifier for the lookup record item.","type":"string"},"values":{"description":"Array of attribute-value pairs for the lookup record item.","items":{"$ref":"#/components/schemas/LookupRecordItemValue"},"type":"array"}},"required":["values","id"],"title":"LookupRecordItemStripped","type":"object","description":"LookupRecordItemStripped"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/lookuprecords/{recordId}":{"delete":{"deprecated":false,"description":"Deletes a single lookup record using its unique identifier.","operationId":"deleteLookupRecord","parameters":[{"in":"path","name":"recordId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupRecord"}}},"description":"Successfully deleted the lookup record."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Delete a lookup record by its ID","tags":["Checkout Options (DOMS)"]}}}}
```
## List all record items (search cached for 5 minutes)
> This part of the API is in Beta status. For details please check the \api-release-life-cycle documentation\.\
\
Search for LookupRecordItem
```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints used by shops to get the current available pickup stores and available service levels like Same-Day delivery.","name":"Checkout Options (DOMS)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LookupRecordItemSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"$ref":"#/components/schemas/SearchOptions"},"query":{"$ref":"#/components/schemas/LookupRecordItemSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"LookupRecordItemSearchPayload","type":"object","description":"LookupRecordItemSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"LookupRecordItemSearchQuery":{"properties":{"and":{"items":{"$ref":"#/components/schemas/LookupRecordItemSearchQuery"},"maxItems":500,"type":"array"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"or":{"items":{"$ref":"#/components/schemas/LookupRecordItemSearchQuery"},"maxItems":500,"type":"array"},"recordRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by recordRef"},"tenantRecordId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by tenantRecordId"},"values":{"allOf":[{"$ref":"#/components/schemas/LookupRecordItemValuesListFilter"}],"description":"Nested list search by values"}},"title":"LookupRecordItemSearchQuery","type":"object","description":"LookupRecordItemSearchQuery"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"maxLength":256,"type":"string"},"notIn":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"LookupRecordItemValuesListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/LookupRecordItemValuesFilter"}],"description":"Contains returns if at least one entry matches"}},"title":"LookupRecordItemValuesListFilter","type":"object","description":"LookupRecordItemValuesListFilter"},"LookupRecordItemValuesFilter":{"properties":{"attributeId":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by attributeId"},"attributeValue":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by attributeValue"}},"title":"LookupRecordItemValuesFilter","type":"object","description":"LookupRecordItemValuesFilter"},"LookupRecordItemPaginatedResult":{"properties":{"lookupRecordItems":{"items":{"$ref":"#/components/schemas/LookupRecordItem"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","lookupRecordItems"],"title":"LookupRecordItemPaginatedResult","type":"object","description":"LookupRecordItemPaginatedResult"},"LookupRecordItem":{"properties":{"id":{"type":"string"},"recordRef":{"description":"Reference to the parent lookup record.","type":"string"},"tenantRecordId":{"description":"Tenant-specific identifier for the lookup record.","maxLength":20,"minLength":1,"type":"string"},"values":{"$ref":"#/components/schemas/LookupRecordItemValue","description":"Array of attribute-value pairs for the lookup record item.","items":{"type":"string"}}},"required":["recordRef","values","id"],"title":"LookupRecordItem","type":"object","description":"LookupRecordItem"},"LookupRecordItemValue":{"properties":{"attributeId":{"description":"Identifier of the attribute.","maxLength":100,"minLength":1,"type":"string"},"attributeValue":{"anyOf":[{"maxLength":150,"minLength":1,"type":"string"},{"type":"number"},{"enum":[null]}],"description":"Value of the attribute (can be string, number, or null)."}},"required":["attributeId","attributeValue"],"title":"LookupRecordItemValue","type":"object","description":"LookupRecordItemValue"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/lookuprecorditems/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for LookupRecordItem","operationId":"searchLookupRecordItem","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupRecordItemSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupRecordItemPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List all record items (search cached for 5 minutes)","tags":["Checkout Options (DOMS)"]}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.fulfillmenttools.com/documentation/by-pillar/availability-and-promising/external-information-lookup/external-lookup-endpoints.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.