Skip to content

Latest commit

 

History

History
40 lines (35 loc) · 13 KB

manifest.md

File metadata and controls

40 lines (35 loc) · 13 KB

Manifest

Example Usage

import { Manifest } from "shippo/models/components";

let value: Manifest = {
  carrierAccount: "adcfdddf8ec64b84ad22772bce3ea37a",
  shipmentDate: "2014-05-16T23:59:59Z",
  transactions: [
    "adcfdddf8ec64b84ad22772bce3ea37a",
  ],
  addressFrom: "d799c2679e644279b59fe661ac8fa488",
  documents: [
    "https://shippo-delivery.s3.amazonaws.com/0fadebf6f60c4aca95fa01bcc59c79ae.pdf?Signature=tlQU3RECwdHUQJQadwqg5bAzGFQ%3D&Expires=1402803835&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
  ],
  objectCreated: new Date("2025-03-11T01:40:18.315Z"),
  objectId: "adcfdddf8ec64b84ad22772bce3ea37a",
  objectOwner: "[email protected]",
  objectUpdated: new Date("2023-07-08T02:32:49.310Z"),
  status: "SUCCESS",
};

Fields

Field Type Required Description Example
carrierAccount string ✔️ ID of carrier account adcfdddf8ec64b84ad22772bce3ea37a
shipmentDate string ✔️ All shipments to be submitted on this day will be closed out.
Must be in the format 2014-01-18T00:35:03.463Z (ISO 8601 date).		 2014-05-16T23:59:59Z
transactions string[] ➖ IDs transactions to use. If you set this to null or not send this parameter,
Shippo will automatically assign all applicable transactions.		 [
"adcfdddf8ec64b84ad22772bce3ea37a"
]
addressFrom string ✔️ ID of the Address object that should be used as pickup address for the scan form.
The USPS will validate this address before creating the scan form.		 d799c2679e644279b59fe661ac8fa488
documents string[] ✔️ An array containing the URLs to all returned manifest documents. [
"https://shippo-delivery.s3.amazonaws.com/0fadebf6f60c4aca95fa01bcc59c79ae.pdf?Signature=tlQU3RECwdHUQJQadwqg5bAzGFQ%3D\u0026Expires=1402803835\u0026AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA"
]
errors string[] ➖ An array of codes and messages describing the error that occurred if any.
objectCreated Date ✔️ Date and time of object creation.
objectId string ✔️ Unique identifier of the given object. adcfdddf8ec64b84ad22772bce3ea37a
objectOwner string ✔️ Username of the user who created the object. [email protected]
objectUpdated Date ✔️ Date and time of last object update.
status components.ManifestStatus ✔️ Indicates the status of the manifest. SUCCESS