All API categories

    Orders API

    22 endpoints

    Order management and fulfilment.

    GET
    Auth Required

    List orders for a collection with optional filters and pagination.

    List orders for a collection with optional filters and pagination.

    Endpoint

    /admin/collection/{collectionId}/orders

    Parameters

    collectionId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "ListOrdersResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Create a new order with items.

    Create a new order with items.

    Endpoint

    /admin/collection/{collectionId}/orders

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    CreateOrderRequest
    Required

    See CreateOrderRequest schema

    Responses

    200
    Success
    {
  "schema": "CreateOrderResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Get analytics summary for multiple orders at once.

    Get analytics summary for multiple orders at once.

    Endpoint

    /admin/collection/{collectionId}/orders/analytics/bulk

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    BulkAnalyticsRequest
    Required

    See BulkAnalyticsRequest schema

    Responses

    200
    Success
    {
  "schema": "BulkAnalyticsResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Get collection-wide analytics summary across all orders.

    Get collection-wide analytics summary across all orders.

    Endpoint

    /admin/collection/{collectionId}/orders/analytics/summary

    Parameters

    collectionId
    path
    string
    Required
    body
    body
    SummaryRequest
    Required

    See SummaryRequest schema

    Responses

    200
    Success
    {
  "schema": "CollectionSummaryResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    order.getAnalytics

    order.getAnalytics

    Endpoint

    /admin/collection/{collectionId}/orders/analytics/{orderId}

    Parameters

    collectionId
    path
    string
    Required
    orderId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "OrderAnalyticsResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Get location-based scan history for an order's tags.

    Get location-based scan history for an order's tags.

    Endpoint

    /admin/collection/{collectionId}/orders/analytics/{orderId}/locations

    Parameters

    collectionId
    path
    string
    Required
    orderId
    path
    string
    Required
    body
    body
    LocationRequest
    Required

    See LocationRequest schema

    Responses

    200
    Success
    {
  "schema": "LocationResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    Get chronological timeline of all scan events for an order's tags.

    Get chronological timeline of all scan events for an order's tags.

    Endpoint

    /admin/collection/{collectionId}/orders/analytics/{orderId}/timeline

    Parameters

    collectionId
    path
    string
    Required
    orderId
    path
    string
    Required
    body
    body
    TimelineRequest
    Required

    See TimelineRequest schema

    Responses

    200
    Success
    {
  "schema": "TimelineResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Find all orders containing items from a specific batch.

    Find all orders containing items from a specific batch.

    Endpoint

    /admin/collection/{collectionId}/orders/batch/{batchId}

    Parameters

    collectionId
    path
    string
    Required
    batchId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "FindOrdersByAttributeResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Get individual order items (not full orders) for a specific batch.

    Get individual order items (not full orders) for a specific batch.

    Endpoint

    /admin/collection/{collectionId}/orders/batch/{batchId}/items

    Parameters

    collectionId
    path
    string
    Required
    batchId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "FindItemsByAttributeResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    order.getOrderIdsByAttribute

    order.getOrderIdsByAttribute

    Endpoint

    /admin/collection/{collectionId}/orders/ids/{attribute}/{value}

    Responses

    200
    Success
    {
  "schema": "GetOrderIdsResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    order.lookup

    order.lookup

    Endpoint

    /admin/collection/{collectionId}/orders/lookup

    Responses

    200
    Success
    {
  "schema": "LookupOrdersResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Find all orders containing items with a specific product ID.

    Find all orders containing items with a specific product ID.

    Endpoint

    /admin/collection/{collectionId}/orders/product/{productId}

    Responses

    200
    Success
    {
  "schema": "LookupByProductResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Get individual order items for a specific product.

    Get individual order items for a specific product.

    Endpoint

    /admin/collection/{collectionId}/orders/product/{productId}/items

    Parameters

    collectionId
    path
    string
    Required
    productId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "FindItemsByAttributeResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    POST
    Auth Required

    order.query

    order.query

    Endpoint

    /admin/collection/{collectionId}/orders/query
    GET
    Auth Required

    order.reports

    order.reports

    Endpoint

    /admin/collection/{collectionId}/orders/reports

    Responses

    200
    Success
    {
  "schema": "ReportsResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Find all orders containing items from a specific variant.

    Find all orders containing items from a specific variant.

    Endpoint

    /admin/collection/{collectionId}/orders/variant/{variantId}

    Parameters

    collectionId
    path
    string
    Required
    variantId
    path
    string
    Required

    Responses

    200
    Success
    {
  "schema": "FindOrdersByAttributeResponse"
}
    400
    Bad request
    401
    Unauthorized
    404
    Not found
    GET
    Auth Required

    Get individual order items for a specific variant.

    Get individual order items for a specific variant.

    Endpoint

    /admin/collection/{collectionId}/orders/variant/{variantId}/items
    GET
    Auth Required

    Get a single order by ID.

    Get a single order by ID.

    Endpoint

    /admin/collection/{collectionId}/orders/{orderId}

    Parameters

    collectionId
    path
    string
    Required
    orderId
    path
    string
    Required
    PUT
    Auth Required

    Update order status or metadata.

    Update order status or metadata.

    Endpoint

    /admin/collection/{collectionId}/orders/{orderId}
    DELETE
    Auth Required

    Delete an order and all its items (cascade delete).

    Delete an order and all its items (cascade delete).

    Endpoint

    /admin/collection/{collectionId}/orders/{orderId}
    GET
    Auth Required

    Get items from an order with pagination support.

    Get items from an order with pagination support.

    Endpoint

    /admin/collection/{collectionId}/orders/{orderId}/items
    POST
    Auth Required

    Add additional items to an existing order.

    Add additional items to an existing order.

    Endpoint

    /admin/collection/{collectionId}/orders/{orderId}/items