pos-get-shipment-activities

Method: GET
Path: /pos/shipping/shipments/{reference_number}/activities

Tags: POSAdmin

Summary

Retrieve shipment activities

Description

Retrieve shipment activities

TypeScript Definition

"pos-get-shipment-activities": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Shipment reference number */
                reference_number: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            activities?: components["schemas"]["ShipmentActivity"][];
                            pagination?: components["schemas"]["Pagination"];
                        };
                    };
                };
            };
        };
    };

Component References

Reference	Resolves To
components["schemas"]["ShipmentActivity"]	ShipmentActivity
components["schemas"]["Pagination"]	Pagination

Parameters

• reference_number (path): Shipment reference number

Responses

200

OK

OpenAPI Definition

{
  "operationId": "pos-get-shipment-activities",
  "summary": "Retrieve shipment activities",
  "description": "Retrieve shipment activities",
  "parameters": [
    {
      "name": "reference_number",
      "in": "path",
      "description": "Shipment reference number",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "activities": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/ShipmentActivity"
                    }
                  },
                  "pagination": {
                    "$ref": "#/components/schemas/Pagination"
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    }
  },
  "tags": [
    "POSAdmin"
  ],
  "x-speakeasy-group": "pos",
  "x-speakeasy-ignore": true
}

---

Auto-generated from OpenAPI spec and TypeScript definitions