Skip to content

PushedSellerShipment ​

Type: schema

Description ​

A marketplace shipment pushed to its seller's store on request (the admin's push of existing shipments to seller stores): the shipment as stored, with the marketplace's references.

TypeScript Definition ​

typescript
PushedSellerShipment: {{
            /** @description Same as `reference_number`. */
            shipment_id: string;
            warehouse_id?: string | null;
            warehouse_name?: string | null;
            reference_number: string;
            order_number: string;
            /** @description The shipment's status, as `shipment.*` events carry it. */
            status: string;
            shipment_items: {
                product_id: string;
                /** @description `null` for products without variants. */
                variant_id: string | null;
                /** @description The seller's own product id, for an item of a marketplace order; otherwise `null`. */
                seller_product_id: string | null;
                /** @description The seller's own variant id, for an item of a marketplace order; otherwise `null`. */
                seller_variant_id: string | null;
                quantity: number;
                /** @description Units shipped free of charge, on top of `quantity`. */
                free_quantity: number;
            }[];
            /** @description The seller store the shipment is pushed to. */
            seller_id: string;
            /** @description The marketplace store the shipment belongs to. */
            marketplace_store_id: string;
            /** @description The order's number on the marketplace. */
            marketplace_order_number: string;
            /** @description The shipment's reference number on the marketplace. */
            marketplace_shipment_number: string;
            /** @description `event_id` of the marketplace event this one was made from; for a pushed shipment, this event's own. */
            marketplace_event_id: string;
            davai_shipment_id?: number | null;
            shipping_tax_type?: string | null;
            delivery_lead_time?: number | null;
            shipping_amount?: number | null;
            shipping_tax_rate?: number | null;
            shipping_tax_amount?: number | null;
            shipping_amount_including_tax?: number | null;
            shipping_estimated_cost?: number;
            shipping_discount_amount?: number;
            items_weight?: number;
            packing_bin_weight?: number | null;
            total_weight?: number;
            total_boxes?: number | null;
            seller_reference_no?: string | null;
            courier_aggregator_name?: string | null;
            courier_company_name?: string | null;
            courier_company_id?: string | null;
            shipping_provider_id?: string | null;
            awb_no?: string | null;
            shipping_label_url?: string | null;
            invoice_url?: string | null;
            tracking_url?: string | null;
            eta_delivery?: string | null;
            cancellation_reason?: string | null;
            cancelled_by?: string | null;
            /** Format: date-time */
            shipped_date?: string | null;
            /** Format: date-time */
            out_for_delivery_date?: string | null;
            /** Format: date-time */
            delivered_date?: string | null;
            /** Format: date-time */
            promised_delivery_date?: string | null;
            /** Format: date-time */
            estimated_delivery_date?: string | null;
            /** Format: date-time */
            revised_shipping_date?: string | null;
            /** Format: date-time */
            return_window?: string | null;
            /** Format: date-time */
            created_at: string;
            /** Format: date-time */
            modified_at: string;
            shipping_option?: string | null;
            packing_option?: string | null;
            /** @enum {string|null} */
            fulfillment_type?: "delivery" | "collect-in-store" | null;
        };
        /**
         * Rounding
         * @description Define how to round the shipping cost
         */
}

OpenAPI Schema ​

json
{
  "title": "PushedSellerShipment",
  "description": "A marketplace shipment pushed to its seller's store on request (the admin's push of existing shipments to seller stores): the shipment as stored, with the marketplace's references.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/PushedSellerShipment",
    "description": "API reference for the PushedSellerShipment schema"
  },
  "required": [
    "shipment_id",
    "reference_number",
    "order_number",
    "status",
    "shipment_items",
    "seller_id",
    "marketplace_store_id",
    "marketplace_order_number",
    "marketplace_shipment_number",
    "marketplace_event_id",
    "created_at",
    "modified_at"
  ],
  "properties": {
    "shipment_id": {
      "description": "Same as `reference_number`.",
      "type": "string"
    },
    "warehouse_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "warehouse_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "reference_number": {
      "type": "string"
    },
    "order_number": {
      "type": "string"
    },
    "status": {
      "description": "The shipment's status, as `shipment.*` events carry it.",
      "type": "string"
    },
    "shipment_items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "product_id": {
            "type": "string"
          },
          "variant_id": {
            "description": "`null` for products without variants.",
            "type": [
              "string",
              "null"
            ]
          },
          "seller_product_id": {
            "description": "The seller's own product id, for an item of a marketplace order; otherwise `null`.",
            "type": [
              "string",
              "null"
            ]
          },
          "seller_variant_id": {
            "description": "The seller's own variant id, for an item of a marketplace order; otherwise `null`.",
            "type": [
              "string",
              "null"
            ]
          },
          "quantity": {
            "type": "integer"
          },
          "free_quantity": {
            "description": "Units shipped free of charge, on top of `quantity`.",
            "type": "integer"
          }
        },
        "required": [
          "product_id",
          "variant_id",
          "seller_product_id",
          "seller_variant_id",
          "quantity",
          "free_quantity"
        ]
      }
    },
    "seller_id": {
      "description": "The seller store the shipment is pushed to.",
      "type": "string"
    },
    "marketplace_store_id": {
      "description": "The marketplace store the shipment belongs to.",
      "type": "string"
    },
    "marketplace_order_number": {
      "description": "The order's number on the marketplace.",
      "type": "string"
    },
    "marketplace_shipment_number": {
      "description": "The shipment's reference number on the marketplace.",
      "type": "string"
    },
    "marketplace_event_id": {
      "description": "`event_id` of the marketplace event this one was made from; for a pushed shipment, this event's own.",
      "type": "string"
    },
    "davai_shipment_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "shipping_tax_type": {
      "type": [
        "string",
        "null"
      ]
    },
    "delivery_lead_time": {
      "type": [
        "integer",
        "null"
      ]
    },
    "shipping_amount": {
      "type": [
        "number",
        "null"
      ]
    },
    "shipping_tax_rate": {
      "type": [
        "number",
        "null"
      ]
    },
    "shipping_tax_amount": {
      "type": [
        "number",
        "null"
      ]
    },
    "shipping_amount_including_tax": {
      "type": [
        "number",
        "null"
      ]
    },
    "shipping_estimated_cost": {
      "type": "number"
    },
    "shipping_discount_amount": {
      "type": "number"
    },
    "items_weight": {
      "type": "number"
    },
    "packing_bin_weight": {
      "type": [
        "number",
        "null"
      ]
    },
    "total_weight": {
      "type": "number"
    },
    "total_boxes": {
      "type": [
        "integer",
        "null"
      ]
    },
    "seller_reference_no": {
      "type": [
        "string",
        "null"
      ]
    },
    "courier_aggregator_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "courier_company_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "courier_company_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "shipping_provider_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "awb_no": {
      "type": [
        "string",
        "null"
      ]
    },
    "shipping_label_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "invoice_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "tracking_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "eta_delivery": {
      "type": [
        "string",
        "null"
      ]
    },
    "cancellation_reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "cancelled_by": {
      "type": [
        "string",
        "null"
      ]
    },
    "shipped_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "out_for_delivery_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "delivered_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "promised_delivery_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "estimated_delivery_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "revised_shipping_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "return_window": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    },
    "shipping_option": {
      "type": [
        "string",
        "null"
      ]
    },
    "packing_option": {
      "type": [
        "string",
        "null"
      ]
    },
    "fulfillment_type": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "delivery",
        "collect-in-store",
        null
      ]
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: