Job

GET /v2/jobs/{job_id}

// status
200

// body
{
  "id": 123456,
  "status": "queued",
  "queued_at": 1530183480,
  "processed_at": null,
  "completed_at": null,
  "payload": {
    "method": "POST",
    "url": "https://api.shipup.co/v2/SOMETHING",
    "body": [
      {
        "some_field": "I will succeed"
      },
      {
        "some_field": "I will fail"
      }
    ]
  }
}

// status
200

// body
{
  "id": 123456,
  "status": "processing",
  "processed_at": 1530183900,
  "queued_at": 1530183480,
  "completed_at": null,
  "payload": {
    "method": "POST",
    "url": "https://api.shipup.co/v2/SOMETHING",
    "body": [
      {
        "some_field": "I will succeed"
      },
      {
        "some_field": "I will fail"
      }
    ]
  }
}

// status
200

// body
{
  "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"
      }
    ]
  }
}

// status
404

Each job object has its own URL, https://api.shipup.co/v2/jobs/{job_id}, where {job_id} is the value of the job's id field. This URL is the job's canonical address in the API.

Response payload

FIELD	DESCRIPTION
id integer	Unique identifier of the job
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