Ordexs API v1 Get an API key

Bulk

List bulk jobs

GEThttps://api.ordexs.com/v1/bulk_jobs
Any API keyPaginated

The store's bulk jobs, newest first. Finished jobs are kept 7 days.

Query parameters

  • limitinteger

    How many objects to return, 1–100. Default 25.

    1–100

  • cursorstring

    The next_cursor from the previous page. Repeat the same filters with it.

    up to 512 characters

Returns

200 OK · A page of jobs. BulkJobList

  • objectstringRequired

    always "list"

  • has_morebooleanRequired
  • next_cursorstring or nullRequired

    Pass as cursor to get the next page. null on the last page.

  • dataarray of BulkJobsRequired
    13 child fields
    • idstring

      starts with blk_

    • objectstring

      always "bulk_job"

    • kindstring

      One of orders.create, orders.update, products.create, products.update, inventory.adjust

    • statusstring

      One of queued, running, completed, cancelled

    • totalinteger
    • processedinteger
    • succeededinteger
    • failedinteger
    • created_atstring

      ISO 8601 date-time, UTC

    • started_atstring or null

      ISO 8601 date-time, UTC

    • finished_atstring or null

      ISO 8601 date-time, UTC

    • expires_atstring or null

      When the job and its results are deleted.

      ISO 8601 date-time, UTC

    • livemodeboolean

Errors

Every error has the same shape. This endpoint can answer with: