---
updatedAt: 2025-11-11T23:06:28.000Z
agentTools:
  projectIndex: https://developers.shipup.co/llms.txt
---

# Job

## Example payload

```json JSON
{
  "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](https://developers.shipup.co/reference/batch-create-or-update-orders)).

## Job attributes

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        FIELD
      </th>

      <th>
        DESCRIPTION
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **status**
        string
      </td>

      <td>
        Job status. One of:\ <code>queued</code>: Request registered\ <code>processing</code>: Request processing\ <code>completed</code>: Request processed\ <code>failed</code>: Request failed
      </td>
    </tr>

    <tr>
      <td>
        **queued\_at**\
        datetime
      </td>

      <td>
        Time at which the request was registered
      </td>
    </tr>

    <tr>
      <td>
        **processed\_at**\
        datetime
      </td>

      <td>
        Time at which the request started being processed
      </td>
    </tr>

    <tr>
      <td>
        **completed\_at**\
        datetime
      </td>

      <td>
        Time at which the request was completed
      </td>
    </tr>

    <tr>
      <td>
        **results**\
        array of objects
      </td>

      <td>
        Array listing the resources that were successfully and unsuccessfully updated or created after processing. Object attributes are:\ <code>status</code>: <code>2xx</code> for success, other values are for failure\ <code>body</code>: Object which keys depend on the type of job
      </td>
    </tr>

    <tr>
      <td>
        **payload**\
        object
      </td>

      <td>
        Original data provided to the job.\
        with at least:\ <code>method</code>: HTTP method used (POST, PUT ...)\ <code>url</code>: Endpoint URL called\ <code>body</code>: Body sent with the request
      </td>
    </tr>
  </tbody>
</Table>