# Check a shipment's address with the carrier

```http
PATCH https://secure.yoprint.com/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/{id}/validate_address
```

- API version: v2
- Operation ID: `v2_public_sales_order_shipment_validate_address`
- Section: Shipping › [Shipments](https://developer.yoprint.com/reference/shipments.md)
- Web page: https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-validate-address/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Checks the shipment's shipping address with UPS address validation, for supported countries, and saves the result on the address. An address already checked is not checked again. The answer is the shipment in the older shape, with its `status` and `items`. `{hash_id}` is the order's `id`; `{id}` is the shipment's `id`.

## Permission

Any member of the team.

## Side effects

- Calls the UPS address validation service once per address and saves the result on the address.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The sales order's or quote's `id` (a hash id). The `ord_` unique key and the order number do not work here. Example `V4keXwwxMQyXw7`.
- `id` (string, required): The shipment's `id` (a hash id). Example `qAKg4jO63uFqjs`.

## Request body

This operation takes no request body.

### Example request

```bash
curl -X PATCH 'https://secure.yoprint.com/v2/api/store/your-team/v2/sales_order/V4keXwwxMQyXw7/shipment/qAKg4jO63uFqjs/validate_address' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required): A shipment, in the older shape (app/Transformers/ShipmentTransformer.php, which always includes `status` and `items`).
  - `id` (string, required)
  - `status_id` (string, required)
  - `delivery_notes` (string | null, optional)
  - `delivery_total` (integer | number | string | null, optional): Older shipping total. Thousandths, an older encoding: `12500` is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (`1234.5` is 1.2345), or as a string (`"1234.5"`) when you send `X-Yoprint-Decimal-Format: exact-v1`. See [Money and quantities](/concepts/money-and-quantities/).
  - `items` (array of objects, optional): Shipment lines, in the older shape.
  - `order_id` (string, optional)
  - `order_scoped_id` (string, optional)
  - `scoped_id` (string, optional)
  - `shipping_address_id` (string | null, optional)
  - `status` (object | null, optional): A status, as the status operations return it.
    - `color` (string, required): A hex color, such as `#2196f3`.
    - `customer_label` (string, required): What customers see in the customer portal. When none is set: `Pending` for `start`, `In Progress` for `in_progress` and `pre_production`, `Completed` for `end`.
    - `id` (string, required)
    - `label` (string, required): The status name people see.
    - `position` (integer, required): Sort order within its list, lowest first.
    - `role` (string, required): Which list the status belongs to: `order`, `quote`, `job`, `shipment`, `purchase_order`, `pipeline` or `customer_message`.
    - `trashed` (boolean, required): true for a deleted status.
    - `type` (string, required): `start` is the first status of its list and `end` the last; `pre_production` and `in_progress` are the ones in between. One of: `"start"`, `"pre_production"`, `"in_progress"`, `"end"`.
    - `pipeline_id` (string, optional): The task preset, for `pipeline` statuses only; absent for other roles.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "delivery_notes": "Leave at reception.",
    "delivery_total": 0,
    "id": "qAKg4jO63uFqjs",
    "items": [],
    "order_id": "V4keXwwxMQyXw7",
    "order_scoped_id": "SO1001",
    "scoped_id": "SHIP-1001",
    "shipping_address_id": "RNG2OuYC20YzXs",
    "status": {
      "color": "#9e9e9e",
      "customer_label": "Pending",
      "id": "43J0pEwV4RKUdO",
      "label": "To pack",
      "position": 1,
      "role": "shipment",
      "trashed": false,
      "type": "start"
    },
    "status_id": "43J0pEwV4RKUdO"
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: The shipment is not on this order. Fix: Check the ids.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: The Shopify order was deleted in Shopify (`shopify_order_deleted_externally`). Fix: Nothing to check: the order is gone in Shopify.
- `500` A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as `action_not_allowed`; an unexpected failure answers `{"message": "Server Error"}`. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.
  - When: The shipment has no shipping address: the body is `{"message": "Server Error"}`. Fix: Set the shipment's address first.

## Related

- [List the shipments of a sales order](https://developer.yoprint.com/reference/shipments/v2-sales-order-shipment-index-for-order.md): `GET /v2/api/store/{team_slug}/v2/sales_order/{unique_key}/shipment`