KAkarrio
Proxy

Create a manifest

Some carriers require shipment manifests to be created for pickups and dropoff. Creating a manifest for a shipment also kicks off billing as a commitment or confirmation of the shipment.

post/v1/proxy/manifest

Request

  • Base URL
    https://karrio.io (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP basic
    • or API key in header Authorization
    • or OAuth 2
      Authorization code/oauth/authorize/
      Token URL/oauth/token/
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

carrier_namestring required

The manifest's carrier

optionsobject
<details> <summary>The options available for the manifest.</summary> 
    {
        "shipments": [
            {
                "tracking_number": "123456789",
                ...
                "meta": {...}
            }
        ]
    }
    </details>
referencestring nullable

The manifest reference

shipment_identifiersstring[] 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.

Response

Changes

No recorded changes to this operation across all 1 revision of this API.