Status page

Job

Example payload

{
  "object": "job",
  "id": 123456,
  "status": "completed",
  "queued_at": 1530183480,
  "processed_at": 1530183900,
  "completed_at": 1530185000,
  "results": [
    {
      "status": 200,
      "body": {
        "some_field": "Some data returned for success"
      }
    },
    {
      "status": 400,
      "body": {
        "errors": {
          "details": "Some detail about an errors that occured for this sub request"
        }
      }
    }
  ],
  "payload": {
    "method": "POST",
    "url": "https://api.shipup.co/v2/SOMETHING",
    "body": [
      {
        "some_field": "I will succeed"
      },
      {
        "some_field": "I will fail"
      }
    ]
  }
}

A job is created when somebody kicks off a job such as creating multiple orders through any of Shipup's batch API endpoint (such as create or update orders in batches).

Job attributes

FIELDDESCRIPTION
status
string		Job status. One of:
queued: Request registered
processing: Request processing
completed: Request processed
failed: Request failed
queued_at
datetime		Time at which the request was registered
processed_at
datetime		Time at which the request started being processed
completed_at
datetime		Time at which the request was completed
results
array of objects		Array listing the resources that were successfully and unsuccessfully updated or created after processing. Object attributes are:
status: 2xx for success, other values are for failure
body: Object which keys depend on the type of job
payload
object		Original data provided to the job.
with at least:
method: HTTP method used (POST, PUT ...)
url: Endpoint URL called
body: Body sent with the request