Skip to content

MarketplaceOrderPayment ​

Type: schema

Description ​

The payment of a seller's copy of a marketplace order. The copy has no payments of its own: the marketplace collects the payment, and this one entry stands for it.

TypeScript Definition ​

typescript
MarketplaceOrderPayment: {{
            /** @enum {string} */
            transaction_type: "payment";
            /**
             * Format: double
             * @description The amount to be paid for the order.
             */
            amount: number;
            /**
             * @description The order's payment status.
             * @enum {string}
             */
            payment_status: "pending" | "success" | "failed" | "partially_paid" | "refund_initiated" | "refunded" | "debit_scheduled" | "collection_due";
            /**
             * Format: date-time
             * @description When the order was paid; `null` until then.
             */
            payment_date: string | null;
            /**
             * @description `credit` while the order awaits a debit or collection on the customer's credit line; otherwise `prepaid`.
             * @enum {string}
             */
            settlement_type: "prepaid" | "credit";
        };
        /**
         * MarketplaceStoreItem
         * @description The marketplace store's copy of a seller's product: its details, categories, variants, and items with their sales channels.
         */
}

OpenAPI Schema ​

json
{
  "title": "MarketplaceOrderPayment",
  "description": "The payment of a seller's copy of a marketplace order. The copy has no payments of its own: the marketplace collects the payment, and this one entry stands for it.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/MarketplaceOrderPayment",
    "description": "API reference for the MarketplaceOrderPayment schema"
  },
  "required": [
    "transaction_type",
    "amount",
    "payment_status",
    "payment_date",
    "settlement_type"
  ],
  "properties": {
    "transaction_type": {
      "type": "string",
      "enum": [
        "payment"
      ]
    },
    "amount": {
      "description": "The amount to be paid for the order.",
      "type": "number",
      "format": "double"
    },
    "payment_status": {
      "description": "The order's payment status.",
      "type": "string",
      "enum": [
        "pending",
        "success",
        "failed",
        "partially_paid",
        "refund_initiated",
        "refunded",
        "debit_scheduled",
        "collection_due"
      ]
    },
    "payment_date": {
      "description": "When the order was paid; `null` until then.",
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "settlement_type": {
      "description": "`credit` while the order awaits a debit or collection on the customer's credit line; otherwise `prepaid`.",
      "type": "string",
      "enum": [
        "prepaid",
        "credit"
      ]
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: