Skip to content
Public API
Esc
↑↓navigate↵open⌘Jpreview

List items

List filters are passed as query parameters — see the conventions in the introduction.

GET/item
Authorization
AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Responses
200

OK.

Array of Item
partIdstring

Part ID (read-only)

partItemIdstring

Part item ID (read-only)

itemStatestring

Item state, enum: PRODUCED, IN_PROGRESS, AVAILABLE, FAILED, SUCCEED (read-only)

itemStatusstring

Item status (read-only)

appIdstring

App ID (read-only)

ticketModelIdstring

Ticket model ID (read-only)

ticketIdstring

Ticket ID (read-only)

failureReasonstring

Failure reason (read-only)

serviceJobIdstring

Service job ID (read-only)

parcelIdstring

Parcel ID (read-only)

addedToParcelAtstring

Date added to parcel (ISO date, read-only)

shippingDeadlinestring

Shipping deadline (ISO date, read-only)

changedSincestring

Last change date (ISO date, read-only)

createdAtstring

Creation date (ISO date, read-only, autoassigned)

401

Authentication failed. All causes return this identical response.

codeinteger
messagestring
typestring
default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger
messagestring
typestring
Try it
Server
Authorization
Request
curl -X GET 'https://next.amfg.ai/engine-service/public-api/v1/item' \
  -H 'Authorization: YOUR_API_KEY'
Response
[
  {
    "partId": "8859",
    "partItemId": "X-88-ORDER-95019-1-1",
    "itemState": "AVAILABLE",
    "itemStatus": "New",
    "appId": "1677",
    "ticketModelId": "4369",
    "ticketId": 1113,
    "failureReason": null,
    "serviceJobId": null,
    "parcelId": null,
    "addedToParcelAt": "2022-04-15T16:21:27.687Z",
    "shippingDeadline": null,
    "changedSince": "2022-04-15T16:21:27.688Z",
    "createdAt": "2022-07-14T07:05:57.909Z"
  }
]