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

# Order

## Example payload

```json JSON
{
    "object": "order",
    "id": 41477,
    "canceled": false,
    "created_at": "2024-07-08T00:00:00Z",
    "custom_variables": null,
    "email": "divina.hickle@considine.test",
    "first_name": "Onyx",
    "language_code": 'en',
    "last_name": "Graham",
    "merchant_id": "ZMEN20579494985",
    "mute_notifications": false,
    "order_number": "ZMEN20579494985",
    "ordered_at": "2024-07-08T00:00:00Z",
    "phone": "848-189-6981",
    "updated_at": "2024-07-17T15:39:59Z",
    "uuid": "af50f332-f5b0-429b-b1ff-726ea3f050be",
    "fulfillments": {
        "object": "list",
        "data": [
            {
                "object": "fulfillment",
                "id": 42916
            }
        ]
    },
    "line_items": {
        "object": "list",
        "data": [
            {
                "object": "line_item",
                "id": 8793
            }
        ]
    },
    "notifications": {
        "object": "list",
        "data": [
            {
                "object": "notification",
                "id": 34768
            }
        ]
    },
    "shipping_address": {
        "object": "address",
        "id": 83760
    },
    "order_details": {
        "object": "order_details",
        "id": 98372
    }
}
```

<br />

## Attributes

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

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

  <tbody>
    <tr>
      <td>
        **canceled**
        boolean
      </td>

      <td>
        Whether or not the order is canceled.
      </td>
    </tr>

    <tr>
      <td>
        **custom\_variables**\
        object
      </td>

      <td>
        Order custom variables
      </td>
    </tr>

    <tr>
      <td>
        **email**\
        string
      </td>

      <td>
        Customer's email address
      </td>
    </tr>

    <tr>
      <td>
        **first\_name**\
        string
      </td>

      <td>
        Customer's first name
      </td>
    </tr>

    <tr>
      <td>
        **language\_code**\
        string
      </td>

      <td>
        Customer's language\
        Defaults to your company's main language if not provided. See [available values](https://developers.shipup.co/reference/available-languages) 
      </td>
    </tr>

    <tr>
      <td>
        **last\_name**\
        string
      </td>

      <td>
        Customer's last name
      </td>
    </tr>

    <tr>
      <td>
        **merchant\_id**\
        string
      </td>

      <td>
        Unique identifier used by the online retailer for the order
      </td>
    </tr>

    <tr>
      <td>
        **mute\_notifications**\
        boolean
      </td>

      <td>
        If set to <code>true</code>, no notification will be generated for this order.
      </td>
    </tr>

    <tr>
      <td>
        **order\_number**\
        string
      </td>

      <td>
        Shop order reference
      </td>
    </tr>

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

      <td>
        Time at which the order was placed. Mandatory to send pre-shipment notifications
      </td>
    </tr>

    <tr>
      <td>
        **phone**\
        string
      </td>

      <td>
        Customer's mobile phone. The phone format should either:  

        * follow the international format (eg. with `+33` or `0033`)
        * use the local (national) format. If so, Shipup adds the international prefix thanks to the shipping address' country.
      </td>
    </tr>

    <tr>
      <td>
        **uuid**\
        string
      </td>

      <td>
        Unique identifier for the object, UUID format.
      </td>
    </tr>

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

      <td>
        Time at which the order was imported into Shipup
      </td>
    </tr>

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

      <td>
        Time at which the order was last updated
      </td>
    </tr>
  </tbody>
</Table>

## Expandable resources

* [Fulfillments](https://developers.shipup.co/reference/fulfillment-api-resource)
* [Line items](https://developers.shipup.co/reference/line-item-api-resource)
* [Notifications](https://developers.shipup.co/reference/notification-api-resource)
* [Shipping address](https://developers.shipup.co/reference/address-api-resource)
* [Order details](https://developers.shipup.co/reference/order-details)