Documents

Upload documents

Upload a shipping document.

post/v1/documents/uploads

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

shipment_idstring required

The documents related shipment.

referencestring nullable

Shipping document file reference

Response

idstring

A unique identifier

carrier_namestring nullable

The shipment carrier

carrier_idstring nullable

The shipment carrier configured identifier

metaobject nullable

provider specific metadata

referencestring nullable

Shipping document file reference

Changes

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