Skip to main content

Retrieve a manifest

GET 
/v1/manifests/:id

Retrieve a shipping manifest.

Request​

Path Parameters

    id stringrequired

Responses​

Schema

    id string

    A unique manifest identifier

    object_type string

    Default value: manifest

    Specifies the object type

    carrier_name stringrequired

    The manifest carrier

    carrier_id stringrequired

    The manifest carrier configured name

    meta

    object

    nullable

    provider specific metadata

    property name* anynullable

    provider specific metadata

    test_mode booleanrequired

    Specified whether it was created with a carrier in test mode

    address

    object

    required

    postal_code stringnullable

    Possible values: <= 10 characters

    The address postal code (required for shipment purchase)

    city stringnullable

    Possible values: <= 30 characters

    The address city. (required for shipment purchase)

    federal_tax_id stringnullable

    Possible values: <= 20 characters

    The party frederal tax id

    state_tax_id stringnullable

    Possible values: <= 20 characters

    The party state id

    person_name stringnullable

    Possible values: <= 50 characters

    Attention to (required for shipment purchase)

    company_name stringnullable

    Possible values: <= 50 characters

    The company name if the party is a company

    country_code stringrequired

    Possible values: [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]

    The address country code

    email stringnullable

    The party email

    phone_number stringnullable

    Possible values: <= 20 characters

    The party phone number.

    state_code stringnullable

    Possible values: <= 20 characters

    The address state code

    residential booleannullable

    Indicate if the address is residential or commercial (enterprise)

    street_number stringnullable

    Possible values: <= 20 characters

    The address street number

    address_line1 stringnullable

    Possible values: <= 50 characters

    The address line with street number
    (required for shipment purchase)

    address_line2 stringnullable

    Possible values: <= 50 characters

    The address line with suite number

    validate_location booleannullable

    Indicate if the address should be validated

    options

    object

    The options available for the manifest.

    { "shipments": [ { "tracking_number": "123456789", ... "meta": {...} } ] }

    property name* any

    Default value: [object Object]

    The options available for the manifest. 
        {
            "shipments": [
                {
                    "tracking_number": "123456789",
                    ...
                    "meta": {...}
                }
            ]
        }
        </details>
    reference stringnullable

    The manifest reference

    shipment_identifiers string[]required

    The list of shipment identifiers you want to add to your manifest.
    shipment_identifier is often a tracking_number or shipment_id returned when you purchase a label.

    metadata

    object

    User metadata for the pickup

    property name* any

    Default value: [object Object]

    User metadata for the pickup

    manifest_url urinullable

    The Manifest file URL

    messages

    object[]

    The list of note or warning messages

  • Array [

    • message string

    The error or warning message

    code string

    The message code

    details

    object

    any additional details

    property name* any

    any additional details

    carrier_name string

    The targeted carrier

    carrier_id string

    The targeted carrier name (unique identifier)

  • ]

Loading...