shipment.cancelled

Type: Webhook
Method: POST

Tags: webhooks

Summary

Shipment cancelled

TypeScript Definition

"shipment-cancelled": {
        parameters: {
            query?: never;
            header?: never;
            path?: never;
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": components["schemas"]["OrderShipment"];
            };
        };
        responses: {
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            410: components["responses"]["WebhookGone"];
            "2XX": components["responses"]["WebhookAccepted"];
            "5XX": components["responses"]["WebhookServerError"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["OrderShipment"]	OrderShipment
components["responses"]["BadRequest"]	BadRequest
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["WebhookGone"]	WebhookGone
components["responses"]["WebhookAccepted"]	WebhookAccepted
components["responses"]["WebhookServerError"]	WebhookServerError

Webhook Payload

Content Types: application/json

Expected Responses

400

Bad request

401

Not authorized for given operation on the Resource

410

Endpoint permanently removed

2XX

Payload accepted

5XX

Temporary server error — we will retry

OpenAPI Definition

{
  "operationId": "shipment-cancelled",
  "summary": "Shipment cancelled",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrderShipment"
        }
      }
    }
  },
  "responses": {
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "410": {
      "$ref": "#/components/responses/WebhookGone"
    },
    "2XX": {
      "$ref": "#/components/responses/WebhookAccepted"
    },
    "5XX": {
      "$ref": "#/components/responses/WebhookServerError"
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions