{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/shipping/manifests/explicit-vs-implicit","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/shipping/manifests/explicit-vs-implicit","default":false,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/shipping/manifests/explicit-vs-implicit","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Explicit vs Implicit Manifests","keywords":"shipping, labels, shipstation, documentation, api","siteUrl":"https://docs.shipstation.com","lang":"en-US","llmstxt":{"hide":false,"title":"ShipStation API LLM Docs","description":"Find links and references to all markdown documentation for use with LLMs","excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"explicit-vs-implicit-manifests","__idx":0},"children":["Explicit vs Implicit Manifests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/shipping/manifests#manifest-requirements-by-carrier"},"children":["carrier requires a physical manifest"]},", you will need to send a request to ShipStation API to create it. You can send a request with a list of specific labels to include in an ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#explicit-manifests"},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["explicit manifest"]}]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Alternately, you can include filter criteria in your request and allow ShipStation API to determine the exact list of labels to include in an ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#implicit-manifests"},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["implicit manifest"]}]},", including a property that allows you to exclude labels from the manifest even if they meet the filter criteria."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"explicit-manifests","__idx":1},"children":["Explicit Manifests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["One way to create manifests in ShipStation API is to explicitly specify which labels to include in the manifest."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create an explicit manifest, you only need to set a single field:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field Name"},"children":["Field Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required?"},"children":["Required?"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label_ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of strings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use this to specify the labels that you want to include in the manifest. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"You may specify up to 500 labels in a single manifest."]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["INFO:"]}," ","When using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label_ids"]}," property,"," ","you no longer need to specify ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carrier_id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warhouse_id"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ship_date"]}," in the request."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request","__idx":2},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/manifests HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __YOUR_API_KEY_HERE__\nContent-Type: application/json\n\n{\n  \"label_ids\": [\"se-29602037\", \"se-29544722\", \"se-29475869\"]\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response","__idx":3},"children":["Example Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Notice that the response includes an ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["array"]}," of manifests. The request may return ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#example-response-with-multiple-manifests"},"children":["more than one manifest"]},"."," ","Each manifest contains an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["href"]}," property containing a URL where the manifest can be downloaded. There is also a top-level"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["href"]}," property that will contain the URL for the first manifest if more than one is returned."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"manifests\": [\n    {\n      \"manifest_id\": \"se-11118\",\n      \"form_id\": \"se-11118\",\n      \"created_at\": \"2020-11-09T18:21:10.59Z\",\n      \"ship_date\": \"2020-11-09T00:00:00Z\",\n      \"shipments\": 3,\n      \"label_ids\": [\n        \"se-29602037\",\n        \"se-29544722\",\n        \"se-29475869\"\n      ],\n      \"warehouse_id\": null,\n      \"submission_id\": \"1120014041604946070483\",\n      \"carrier_id\": \"se-88270\",\n      \"manifest_download\": {\n        \"href\": \"https://api-stage.shipengine.com/v1/downloads/0/pj37Bb5hi0qdslHc7_wCVQ/manifest-11118.pdf\"\n      }\n    }\n  ],\n  \"request_id\": \"7de36d42-8343-4247-95ce-153d8b615d1f\",\n  \"errors\": [],\n  \"manifest_id\": \"se-11118\",\n  \"form_id\": \"se-11118\",\n  \"created_at\": \"2020-11-09T18:21:10.59Z\",\n  \"ship_date\": \"2020-11-09T00:00:00Z\",\n  \"shipments\": 1,\n  \"label_ids\": [\n    \"se-29602037\",\n    \"se-29544722\",\n    \"se-29475869\"\n  ],\n  \"warehouse_id\": null,\n  \"submission_id\": \"1120014041604946070483\",\n  \"carrier_id\": \"se-88270\",\n  \"manifest_download\": {\n    \"href\": \"https://api-stage.shipengine.com/v1/downloads/0/pj37Bb5hi0qdslHc7_wCVQ/manifest-11118.pdf\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-with-multiple-manifests","__idx":4},"children":["Example Response with Multiple Manifests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This response includes two manifest objects. ShipStation API will automatically split your labels across multiple manifests if you have more than 500 labels in the request or if the specified ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label_ids"]}," span multiple carriers, warehouses, or ship dates."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example, if you specify ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label_ids"]}," for USPS and FedEx for the same warehouse and ship date, ShipStation API will return two manifests - one for USPS labels with the specified warehouse and ship date and one for FedEx labels with the specified warehouse and ship date."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each manifest object contains an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["href"]}," property that contains a URL where you can download a PDF version of the manifest. There is also a top-level ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["href"]}," that includes a URL where you can download the first manifest if multiple manifests are returned. Each  manifest object indicates the specific ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label_ids"]}," that are included in the manifest."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"{\n  \"manifests\": [\n    {\n      \"manifest_id\": \"se-11116\",\n      \"form_id\": \"se-11116\",\n      \"created_at\": \"2020-11-09T18:16:09.793Z\",\n      \"ship_date\": \"2020-11-09T00:00:00Z\",\n      \"shipments\": 1,\n      \"label_ids\": [\n        \"se-1050621\"\n      ],\n      \"warehouse_id\": null,\n      \"submission_id\": \"9475711201080306528571\",\n      \"carrier_id\": \"se-82785\",\n      \"manifest_download\": {\n        \"href\": \"https://api-stage.shipengine.com/v1/downloads/0/mQ3QZQL6-0SLESTz43Y8vw/manifest-11116.pdf\"\n      }\n    },\n    {\n      \"manifest_id\": \"se-11117\",\n      \"form_id\": \"se-11117\",\n      \"created_at\": \"2020-11-09T18:16:11.233Z\",\n      \"ship_date\": \"2020-11-09T00:00:00Z\",\n      \"shipments\": 1,\n      \"label_ids\": [\n        \"se-1050622\"\n      ],\n      \"warehouse_id\": null,\n      \"submission_id\": \"1120014041604945770433\",\n      \"carrier_id\": \"se-88270\",\n      \"manifest_download\": {\n        \"href\": \"https://api-stage.shipengine.com/v1/downloads/0/5GOUrT4TRkWgygJyvJt0kA/manifest-11117.pdf\"\n      }\n    }\n  ],\n  \"request_id\": \"9367f24f-9aa6-4358-8dd7-a73bb38e8870\",\n  \"errors\": [],\n  \"manifest_id\": \"se-11116\",\n  \"form_id\": \"se-11116\",\n  \"created_at\": \"2020-11-09T18:16:09.793Z\",\n  \"ship_date\": \"2020-11-09T00:00:00Z\",\n  \"shipments\": 1,\n  \"label_ids\": [\n    \"se-1050621\",\n    \"se-1050622\"\n  ],\n  \"warehouse_id\": null,\n  \"submission_id\": \"9475711201080306528571\",\n  \"carrier_id\": \"se-82785\",\n  \"manifest_download\": {\n    \"href\": \"https://api-stage.shipengine.com/v1/downloads/0/mQ3QZQL6-0SLESTz43Y8vw/manifest-11116.pdf\"\n  }\n}\n","lang":"js"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"implicit-manifests","__idx":5},"children":["Implicit Manifests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You may also create a manifest that includes all the labels that match the specific criteria you specify in the request. Labels that do not meet the specified criteria will be excluded from the manifest."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You may specify values for one or more of the properties below. ShipStation API will create a manifest that includes all labels that match this criteria."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excluded_label_ids"]}," property to specify label IDs that should be excluded from the manifest ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["even if they match the specified criteria."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["INFO:"]}," ","If your criteria results in more than 500 labels, ShipStation API will automatically split your labels into multiple manifests."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carrier_id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," The ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/reference/list-carriers#carrier-ids"},"children":["carrier ID"]}," you wish to create a manifest for. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," This will exclude labels that do not use this specified ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carrier_id"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excluded_label_ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string array"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," The label IDS that you do NOT wish to manifest, even if they meet the rest of the specified criteria."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warehouse_id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," The ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/reference/create-warehouse"},"children":["Warehouse ID"]}," this manifest is being created for. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"This will exclude labels that do not use the specified ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warehouse_id"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ship_date"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["date string"]},", (",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601"},"children":["ISO 8601 Standard"]},"), ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," The ship date you want to include labels for. Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2019-07-25T15:24:46.657Z"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["INFO:"]}," ","Each ShipStation API manifest is created for a specific warehouse, so you'll need to provide the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warehouse_id"]}," rather than the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ship_from"]}," address. You can ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/reference/create-warehouse"},"children":["create a warehouse"]}," for each location that you want to create manifests for."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-1","__idx":6},"children":["Example Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST /v1/manifests"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/manifests HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __YOUR_API_KEY_HERE__\nContent-Type: application/json\n\n{\n  \"carrier_id\": \"se-123890\",\n  \"excluded_label_ids\": [],\n  \"warehouse_id\": \"se-11921\",\n  \"ship_date\": \"2019-07-25T05:00:00.000Z\"\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-1","__idx":7},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"manifests\": [\n        {\n            \"manifest_id\": \"se-11119\",\n            \"form_id\": \"se-11119\",\n            \"created_at\": \"2020-11-09T19:59:22.837Z\",\n            \"ship_date\": \"2020-11-09T00:00:00Z\",\n            \"shipments\": 3,\n            \"label_ids\": [\n                \"se-1050678\",\n                \"se-1050679\",\n                \"se-1050680\"\n            ],\n            \"warehouse_id\": \"se-107273\",\n            \"submission_id\": \"9475711201080306735429\",\n            \"carrier_id\": \"se-82785\",\n            \"manifest_download\": {\n                \"href\": \"https://api-stage.shipengine.com/v1/downloads/0/WPZ_DNt2dUKPX4L9pOh71g/manifest-11119.pdf\"\n            }\n        }\n    ],\n    \"request_id\": \"ed87e59c-bd95-468b-a4fb-5b55e8630df9\",\n    \"errors\": [],\n    \"manifest_id\": \"se-11119\",\n    \"form_id\": \"se-11119\",\n    \"created_at\": \"2020-11-09T19:59:22.837Z\",\n    \"ship_date\": \"2020-11-09T00:00:00Z\",\n    \"shipments\": 3,\n    \"label_ids\": [\n        \"se-1050678\",\n        \"se-1050679\",\n        \"se-1050680\"\n    ],\n    \"warehouse_id\": \"se-107273\",\n    \"submission_id\": \"9475711201080306735429\",\n    \"carrier_id\": \"se-82785\",\n    \"manifest_download\": {\n        \"href\": \"https://api-stage.shipengine.com/v1/downloads/0/WPZ_DNt2dUKPX4L9pOh71g/manifest-11119.pdf\"\n    }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"group-labels-into-multiple-manifests","__idx":8},"children":["Group Labels into Multiple Manifests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you have multiple outgoing shipments per day, you may want to group your daily labels into more than one manifest."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use either the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label_ids"]}," property or the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excluded_label_ids"]}," property to group your control which labels"," ","are included in each manifest and avoid overlap. A label should be included in only one manifest."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["INFO:"]}," ","You may use ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["either"]}," the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label_ids"]}," property ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["or"]}," the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excluded_label_ids"]}," property but not both."," ","If you use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excluded_label_ids"]}," property, you must also include the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/reference/list-carriers"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carrier_id"]}]},", ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/reference/create-warehouse"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warehouse_id"]}]},", and"," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/shipping/ship-dates"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ship_date"]}]}," in your request."]}]}]},"headings":[{"value":"Explicit vs Implicit Manifests","id":"explicit-vs-implicit-manifests","depth":1},{"value":"Explicit Manifests","id":"explicit-manifests","depth":2},{"value":"Example Request","id":"example-request","depth":3},{"value":"Example Response","id":"example-response","depth":3},{"value":"Example Response with Multiple Manifests","id":"example-response-with-multiple-manifests","depth":3},{"value":"Implicit Manifests","id":"implicit-manifests","depth":2},{"value":"Example Request","id":"example-request-1","depth":3},{"value":"Example Response","id":"example-response-1","depth":3},{"value":"Group Labels into Multiple Manifests","id":"group-labels-into-multiple-manifests","depth":3}],"frontmatter":{"seo":{"title":"Explicit vs Implicit Manifests"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipengine/docs/shipping/manifests/explicit-vs-implicit","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}