List Shipments

v1.0.0

Get list of Shipments

Input

{
  "type": "object",
  "properties": {
    "batch_id": {
      "type": "string",
      "description": "A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc."
    },
    "created_at_end": {
      "type": "string",
      "format": "date-time"
    },
    "created_at_start": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at_end": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at_start": {
      "type": "string",
      "format": "date-time"
    },
    "page": {
      "type": "integer",
      "format": "int32"
    },
    "page_size": {
      "type": "integer",
      "format": "int32"
    },
    "sales_order_id": {
      "type": "string"
    },
    "shipment_status": {
      "type": "string",
      "description": "The possible shipment status values",
      "enum": [
        "pending",
        "processing",
        "label_purchased",
        "cancelled"
      ]
    },
    "sort_by": {
      "type": "string",
      "description": "The possible shipments sort by values",
      "enum": [
        "modified_at",
        "created_at"
      ]
    },
    "sort_dir": {
      "type": "object"
    },
    "tag": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "A list shipment response body",
  "required": [
    "links",
    "page",
    "pages",
    "shipments",
    "total"
  ],
  "properties": {
    "links": {
      "type": "object"
    },
    "page": {
      "type": "integer",
      "format": "int32"
    },
    "pages": {
      "type": "integer",
      "format": "int32"
    },
    "shipments": {
      "type": "array",
      "description": "The list of shipments returned by the api call",
      "items": {
        "description": "A shipment object",
        "type": "object"
      }
    },
    "total": {
      "type": "integer",
      "format": "int64",
      "description": "Total number of shipments returned by the api call"
    }
  },
  "additionalProperties": false
}