---
title: "Create a manifest"
method: POST
path: "/v1/manifests"
tags: ["Manifests"]
---

# Create a manifest

`POST /v1/manifests`

Create a manifest for one or many shipments with labels already purchased.

## Request body

- ManifestData
  - `carrier_name` string, required — The manifest's carrier
  - `address` AddressData, required
    - `postal_code` string, nullable — The address postal code **(required for shipment purchase)**
    - `city` string, nullable — The address city. **(required for shipment purchase)**
    - `federal_tax_id` string, nullable — The party frederal tax id
    - `state_tax_id` string, nullable — The party state id
    - `person_name` string, nullable — Attention to **(required for shipment purchase)**
    - `company_name` string, nullable — The company name if the party is a company
    - `country_code` 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BM' | 'BN' | 'BO' | 'BR' | 'BS' | 'BT' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HN' | 'HR' | 'HT' | 'HU' | 'IC' | 'ID' | 'IE' | 'IL' | 'IN' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KV' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TG' | 'TH' | 'TJ' | 'TL' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WS' | 'XB' | 'XC' | 'XE' | 'XM' | 'XN' | 'XS' | 'XY' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'EH' | 'IM' | 'BL' | 'MF' | 'SX', required — The address country code
    - `email` string, nullable — The party email
    - `phone_number` string, nullable — The party phone number.
    - `state_code` string, nullable — The address state code
    - `residential` boolean, nullable — Indicate if the address is residential or commercial (enterprise)
    - `street_number` string, nullable — The address street number
    - `address_line1` string, nullable — The address line with street number <br/> **(required for shipment purchase)**
    - `address_line2` string, nullable — The address line with suite number
    - `validate_location` boolean, nullable — Indicate if the address should be validated
  - `options` object — <details> <summary>The options available for the manifest.</summary> { "shipments": [ { "tracking_number": "123456789", ... "meta": {...} } ] } </details>
  - `reference` string, nullable — The manifest reference
  - `shipment_ids` string[], required — The list of existing shipment object ids with label purchased.

## Response `201`

- Manifest
  - `id` string — A unique manifest identifier
  - `object_type` string — Specifies the object type
  - `carrier_name` string, required — The manifest carrier
  - `carrier_id` string, required — The manifest carrier configured name
  - `meta` object, nullable — provider specific metadata
  - `test_mode` boolean, required — Specified whether it was created with a carrier in test mode
  - `address` AddressData, required
    - `postal_code` string, nullable — The address postal code **(required for shipment purchase)**
    - `city` string, nullable — The address city. **(required for shipment purchase)**
    - `federal_tax_id` string, nullable — The party frederal tax id
    - `state_tax_id` string, nullable — The party state id
    - `person_name` string, nullable — Attention to **(required for shipment purchase)**
    - `company_name` string, nullable — The company name if the party is a company
    - `country_code` 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BM' | 'BN' | 'BO' | 'BR' | 'BS' | 'BT' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HN' | 'HR' | 'HT' | 'HU' | 'IC' | 'ID' | 'IE' | 'IL' | 'IN' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KV' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PR' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TG' | 'TH' | 'TJ' | 'TL' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WS' | 'XB' | 'XC' | 'XE' | 'XM' | 'XN' | 'XS' | 'XY' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'EH' | 'IM' | 'BL' | 'MF' | 'SX', required — The address country code
    - `email` string, nullable — The party email
    - `phone_number` string, nullable — The party phone number.
    - `state_code` string, nullable — The address state code
    - `residential` boolean, nullable — Indicate if the address is residential or commercial (enterprise)
    - `street_number` string, nullable — The address street number
    - `address_line1` string, nullable — The address line with street number <br/> **(required for shipment purchase)**
    - `address_line2` string, nullable — The address line with suite number
    - `validate_location` boolean, nullable — Indicate if the address should be validated
  - `options` object — <details> <summary>The options available for the manifest.</summary> { "shipments": [ { "tracking_number": "123456789", ... "meta": {...} } ] } </details>
  - `reference` string, nullable — The manifest reference
  - `shipment_identifiers` string[], required — The list of shipment identifiers you want to add to your manifest.<br/> shipment_identifier is often a tracking_number or shipment_id returned when you purchase a label.
  - `metadata` object — User metadata for the pickup
  - `manifest_url` string, uri, nullable — The Manifest file URL
  - `messages` Message[] — The list of note or warning messages
    - `message` string — The error or warning message
    - `code` string — The message code
    - `details` object — any additional details
    - `carrier_name` string — The targeted carrier
    - `carrier_id` string — The targeted carrier name (unique identifier)

## Other responses

- `400`
- `424`
- `500`

---

[API](https://skmtc.dev/karrio/apis/karrio-api.md) · [All operations](https://skmtc.dev/karrio/apis/karrio-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/karrio/karrio-api/revisions/76ab3b7c3a61/schema)