Skip to content

ShipmentMarketplaceFields ​

Type: schema

Description ​

Shipment fields returned for marketplace stores only.

TypeScript Definition ​

typescript
ShipmentMarketplaceFields: {{
            reference_number?: string;
            /** Format: double */
            sub_total?: number;
            /** Format: double */
            sub_total_including_tax?: number;
            /** Format: double */
            grand_total?: number;
            /** Format: double */
            coupon_discount_amount?: number;
            /** Format: double */
            promotion_discount_amount?: number;
            /** Format: double */
            loyalty_point_redeemed?: number;
            seller_id?: string | null;
            seller_detail?: Record<string, never> | null;
            marketplace_listing?: unknown[];
            sales_channel?: {
                id: string;
                name: string;
                type: string;
            };
        };
        /** ShipmentPackingAndProgression */
}

OpenAPI Schema ​

json
{
  "description": "Shipment fields returned for marketplace stores only.",
  "type": "object",
  "properties": {
    "reference_number": {
      "type": "string"
    },
    "sub_total": {
      "type": "number",
      "format": "double"
    },
    "sub_total_including_tax": {
      "type": "number",
      "format": "double"
    },
    "grand_total": {
      "type": "number",
      "format": "double"
    },
    "coupon_discount_amount": {
      "type": "number",
      "format": "double"
    },
    "promotion_discount_amount": {
      "type": "number",
      "format": "double"
    },
    "loyalty_point_redeemed": {
      "type": "number",
      "format": "double"
    },
    "seller_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "seller_detail": {
      "type": [
        "object",
        "null"
      ]
    },
    "marketplace_listing": {
      "type": "array"
    },
    "sales_channel": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "type"
      ]
    }
  },
  "title": "ShipmentMarketplaceFields",
  "x-tags": [
    "Shipping"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: