Sign in
manifests

Get manifest request by ID

Get Manifest Request By Id

get/v1/manifests/requests/{manifest_request_id}

Response

The request was a success.

manifest_idstring required

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

form_idstring required

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

created_atstring date-time required

The date-time that the manifest was created

ship_datestring date-time required

The date-time that the manifests shipments will be picked up

shipmentsinteger required

The number of shipments that are included in this manifest

warehouse_idstring required

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

submission_idstring required

A string that uniquely identifies the submission

carrier_idstring required

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

label_idsSeId[]

An array of the label ids used in this manifest.

request_idstring uuid required

A UUID (a.k.a. GUID) that uniquely identifies a resource

Example response

{
  "manifests": [
    {
      "manifest_id": "se-28529731",
      "form_id": "se-28529731",
      "created_at": "2019-07-12T13:37:39.050Z",
      "ship_date": "2019-07-12T13:37:39.050Z",
      "shipments": 100,
      "label_ids": [
        "se-28529731"
      ],
      "warehouse_id": "se-28529731",
      "submission_id": "9475711899564878915476",
      "carrier_id": "se-28529731",
      "manifest_download": {
        "href": "https://example.com/resource"
      }
    }
  ],
  "manifest_requests": [
    {
      "manifest_request_id": "se-28529731"
    }
  ],
  "manifest_id": "se-28529731",
  "form_id": "se-28529731",
  "created_at": "2019-07-12T13:37:39.050Z",
  "ship_date": "2019-07-12T13:37:39.050Z",
  "shipments": 100,
  "warehouse_id": "se-28529731",
  "submission_id": "9475711899564878915476",
  "carrier_id": "se-28529731",
  "manifest_download": {
    "href": "https://example.com/resource"
  },
  "label_ids": [
    "se-28529731"
  ],
  "request_id": "aa3d8e8e-462b-4476-9618-72db7f7b7009",
  "errors": [
    {
      "message": "Body of request cannot be null.",
      "carrier_id": "se-28529731",
      "carrier_code": "dhl_express",
      "field_name": "shipment.ship_to.phone_number"
    }
  ]
}

Changes

Changed in 1 of the 5 revisions of this API.24

  • f3a66d20456524See the full diff
    • ●

      added the new freight_connection_inactive enum value to the allOf[subschema #4: error_with_label_id_response_body]/errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new freight_connection_inactive enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new freight_connection_inactive enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new freight_connection_inactive enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new freight_provider_id_required enum value to the allOf[subschema #4: error_with_label_id_response_body]/errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new freight_provider_id_required enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new freight_provider_id_required enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new freight_provider_id_required enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_batchable enum value to the allOf[subschema #4: error_with_label_id_response_body]/errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_batchable enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_batchable enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_batchable enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_found enum value to the allOf[subschema #4: error_with_label_id_response_body]/errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new freight_shipment_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_available enum value to the allOf[subschema #4: error_with_label_id_response_body]/errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_available enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_available enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_available enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_found enum value to the allOf[subschema #4: error_with_label_id_response_body]/errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new freight_tracking_not_found enum value to the errors/items/allOf[subschema #1: error]/error_code/allOf[subschema #1: error_code]/ response property for the response status 500

      response-property-enum-value-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog