---
# System prepended metadata

title: integration

---

# integration
[toc]

## create tracking
### request body

```json=
{
    "carrierIdentifier": {
        "type": "MC_NUMBER",
        "value": "740221"
    },
    "shipmentIdentifiers": [
        {
            "type": "BILL_OF_LADING",
            "value": "DORD202206170025"
        }
    ],
    "shipmentStops": [
        {
            "appointmentWindow": {
                "startDateTime": "2022-06-17T10:00:00",
                "endDateTime": "2022-06-17T10:00:00",
                "localTimeZoneIdentifier": "America/Chicago"
            },
            "location": {
                "address": {
                    "postalCode": "60106",
                    "addressLines": [
                        "371 MEYER ROAD"
                    ],
                    "city": "BENSENVILLE",
                    "state": "IL",
                    "country": "US"
                },
                "contact": {
                    "companyName": "MORRISON EXPRESS CO., LTD. "
                }
            },
            "stopNumber": 1
        },
        {
            "appointmentWindow": {
                "startDateTime": "2022-06-17T16:00:00",
                "endDateTime": "2022-06-17T16:00:00",
                "localTimeZoneIdentifier": "America/Chicago"
            },
            "location": {
                "address": {
                    "postalCode": "53158",
                    "addressLines": [
                        "11500 80TH AVE"
                    ],
                    "city": "PLEASANT PRAIRIE",
                    "state": "WI",
                    "country": "US"
                },
                "contact": {
                    "companyName": "ARVATO NORTH AMERICA"
                }
            },
            "stopNumber": 2
        },
        {
            "appointmentWindow": {
                "startDateTime": "2022-06-17T18:00:00",
                "endDateTime": "2022-06-17T18:00:00",
                "localTimeZoneIdentifier": "America/Chicago"
            },
            "location": {
                "address": {
                    "postalCode": "5315800",
                    "addressLines": [
                        "11500 80th AVENUE"
                    ],
                    "city": "PLEASANT PRAIRIE",
                    "state": "WI",
                    "country": "US"
                },
                "contact": {
                    "companyName": "SHIP TO:Arvato Services LLC"
                }
            },
            "stopNumber": 3
        }
    ],
    "equipmentIdentifiers": [
        {
            "type": "VEHICLE_ID",
            "value": "99"
        }
    ],
    "attributes": [
        {
            "name": "level",
            "value": "DISPATCH"
        }
    ],
    "apiConfiguration": {
        "webhookEndpointConfigName": "webhook-config-for-tms-dev"
    }
}
```

### response body

```json=
{
    "httpStatusCode": 400,
    "httpMessage": "Bad Request",
    "errors": [
        {
            "severity": "ERROR",
            "message": "shipmentStops[2].location.address, Postal code should be of the format: 90210 or 90210-0001 or 90210 0001 for US postal codes.",
            "diagnostic": "shipmentStops[2].location.address",
            "source": "SYSTEM"
        }
    ],
    "supportReferenceId": "01b77e2b-dd44-4f6b-a6c7-7c6c4090dac5"
}
```


## address validation

### request body
```json=
{
    "country": "US",
    "postalCode": "5315800",
    "state": "WI",
    "city": "PLEASANT PRAIRIE",
    "addressLines": [
        "11500 80th AVENUE"
    ]
}
```

### response body
```json=
{
    "addressLines": [
        "11500 80TH AVE"
    ],
    "city": "PLEASANT PRAIRIE",
    "state": "WI",
    "postalCode": "53158-2909",
    "country": "US",
    "residential": false,
    "geoCoordinates": {
        "latitude": 42.50976,
        "longitude": -87.90294,
        "timeZone": "America/Chicago"
    }
}
```