pos-update-shipment

Method: PUT
Path: /pos/shipping/shipments/{reference_number}/manual-update

Tags: POSAdmin

Summary

Update shipment detail

Description

Update shipment detail

Pos SDK Usage

SDK Method: pos.updateShipment()

Example:

const { data, error } = await pos.updateShipment(
  { reference_number: "SHIP-2024-001234" },
  {
    status: "shipped",
    awb_no: "AWB123456789",
    courier_company_name: "BlueDart",
    shipping_label_url: "https://example.com/label.pdf",
    tracking_url: "https://tracking.example.com/AWB123456789",
    eta_delivery: "2024-01-15T10:00:00Z",
    shipped_date: "2024-01-10T14:30:00Z"
  }
);

if (error) {
  console.error("Failed to update shipment:", error.message);
} else {
  console.log("Shipment updated successfully:", data.message);
  const shipment = data.content?.shipment;
  console.log(`Updated shipment status:`, shipment?.shipments?.[0]?.status);
}

// Update delivery status
const { data: deliveryData, error: deliveryError } = await pos.updateShipment(
  { reference_number: "SHIP-2024-001234" },
  {
    status: "delivered",
    delivered_date: "2024-01-15T16:45:00Z"
  }
);

TypeScript Definition

"pos-update-shipment": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Shipment reference number */
                reference_number: string;
            };
            cookie?: never;
        };
        requestBody?: {
            content: {
                "application/json": {
                    status?: string;
                    warehouse_id?: string;
                    awb_no?: string;
                    courier_company_name?: string;
                    shipping_label_url?: string;
                    tracking_url?: string;
                    manual_shipping_charges?: number;
                    /** Format: date-time */
                    eta_delivery?: string;
                    /** Format: date-time */
                    shipped_date?: string;
                    /** Format: date-time */
                    out_for_delivery_date?: string;
                    /** Format: date-time */
                    delivered_date?: string;
                };
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message?: string;
                        success?: boolean;
                        content?: {
                            shipment?: components["schemas"]["ShipmentDetail"];
                        };
                    };
                };
            };
        };

    }

Component References

Reference	Resolves To
components["schemas"]["ShipmentDetail"]	ShipmentDetail

Parameters

• reference_number (path): Shipment reference number

Request Body

Content Types: application/json

Responses

200

OK

OpenAPI Definition

{
  "operationId": "pos-update-shipment",
  "summary": "Update shipment detail",
  "description": "Update shipment detail",
  "parameters": [
    {
      "name": "reference_number",
      "in": "path",
      "description": "Shipment reference number",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "status": {
              "type": "string"
            },
            "warehouse_id": {
              "type": "string"
            },
            "awb_no": {
              "type": "string"
            },
            "courier_company_name": {
              "type": "string"
            },
            "shipping_label_url": {
              "type": "string"
            },
            "tracking_url": {
              "type": "string"
            },
            "manual_shipping_charges": {
              "type": "number"
            },
            "eta_delivery": {
              "type": "string",
              "format": "date-time"
            },
            "shipped_date": {
              "type": "string",
              "format": "date-time"
            },
            "out_for_delivery_date": {
              "type": "string",
              "format": "date-time"
            },
            "delivered_date": {
              "type": "string",
              "format": "date-time"
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "shipment": {
                    "$ref": "#/components/schemas/ShipmentDetail"
                  }
                },
                "type": "object"
              }
            }
          }
        }
      }
    }
  },
  "tags": [
    "POSAdmin"
  ],
  "x-speakeasy-group": "pos",
  "x-speakeasy-ignore": true
}

---

Auto-generated from OpenAPI spec and TypeScript definitions