Two · Schema

CreateOrderRequestSchema

CompanyB2B PaymentsFinTechAPI PlatformCheckoutTrade Accounts

Properties

Name Type Description
gross_amount object net_amount + tax_amount
net_amount string Total before tax — sum of all line items excluding tax.
currency object Currency code in ISO 4217 format. E.g. 'NOK'
discount_amount string Deprecated, discount amount is only applicable at line item level
discount_rate string Deprecated, discount rate is only applicable at line item level
tax_amount string Total tax (e.g. VAT) applied to the order.
buyer_department object Department the purchase is to be registered on
buyer_project object Project the purchase is to be registered on
buyer_purchase_order_number object Purchase order number to attribute to the order
buyer_reference object General buyer reference field for information that is not covered by the specific reference fields, e.g. PO-number. Note: Maximum 140 characters
buyer_vat_number object Vat number associated with the buyer company
line_items array List of the line items that constitute the order
merchant_order_id string Your order ID to register against the order
merchant_reference object Field set by merchant for adding a reference to be used internally by the merchant. Does not appear on invoice.
merchant_additional_info object Additional info the merchant can connect to the order
invoice_details object Invoice details are provided by the merchant via Merchant Portal when invoice_type is DIRECT_INVOICE, Two Bank or a 3rd-party bank when invoice_type is FUNDED_INVOICE and empty when invoice_type is CA
merchant_short_name object Deprecated. Use merchant_id where possible.
shipping_details object Shipping details including carrier information and delivery method. For merchants offering multiple fulfillment options, the `delivery_method` field is needed for order validation and processing workf
order_note object General note/message from the buyer to the merchant
billing_address object Order billing address
shipping_address object Order shipping address
tax_subtotals object List of tax subtotals for unique tax brackets
terms object If set, the order will be placed with the specified terms. This is in beta and only open for limited users. Please contact us if you would like to integrate with this feature. It cannot be used with i
merchant_invoice_branding_id object ID of the merchant's invoice branding configuration
merchant_invoice_store_branding_id object ID of the merchant's store-specific invoice branding configuration
order_placed_date object Date order was placed (UTC). If not specified, defaults to current timestamp.
order_type object Type of order (Buyer or Merchant initiated)
sale_country_code object Optional sale country code (ISO 3166 Alpha-2) to use for this order, if null defaults to buyer country code.
merchant_payout_account_alias object Optional payee account alias account identifier for multiple accounts setup.
recurring object If set to true, an invoice will be generated periodically according to the specification provided in recurring_details
merchant_invoice_branding_reference object Reference to merchant's invoice branding configuration
merchant_invoice_store_branding_reference object Reference to merchant's store-specific invoice branding configuration
buyer object Fields representing the buyer
electronic_invoice_recipient object electronic_invoice_recipient
preferred_distribution_method object Allows merchant to set the method of distribution for the invoice and credit notes of the order, if not set will default to all methods
recurring_details object Currently not available
merchant_id object A globally unique merchant ID set by Two.
merchant_urls object List of urls hosted by the merchant.
order_origination object IN_STORE orders are not enabled by default. Please reach out to us if you would like to discuss IN_STORE orders.
tracking_id object Tracking ID from `POST /order_intent`
vendor_name object This is an optional vendor name that is used to refer to the seller in a marketplace setup.
vendor_id object Optional vendor ID for your reference
merchant_user_id object Your internal ID of the user (the employee of your business customer) registered for one-click purchase through the Two Trade Account Onboarding API.
billing_account_id object ID for the billing account linked to this order. Do not pass terms when setting billing_account_id; billing account payment terms take precedence. The billing account buyer company must match the orde
disallow_portal_mutation object If set to true, state-mutating actions (fulfill, cancel, refund) cannot be performed on this order through the merchant portal. Use this for orders managed by external systems (ERPs, PSPs) that track
credit_line_id object ID of the credit line used to fund the order, created through the Two Credit Line API.
View JSON Schema on GitHub

JSON Schema

two-create-order-request-schema-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/two/json-schema/two-create-order-request-schema-schema.json",
  "title": "CreateOrderRequestSchema",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/two-openapi.yaml#/components/schemas/CreateOrderRequestSchema",
  "properties": {
    "gross_amount": {
      "anyOf": [
        {
          "format": "decimal",
          "pattern": "^-?[0-9]+(\\.[0-9]{0,2})?",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "net_amount + tax_amount",
      "title": "Gross Amount"
    },
    "net_amount": {
      "description": "Total before tax — sum of all line items excluding tax.",
      "format": "decimal",
      "pattern": "^-?[0-9]+(\\.[0-9]{0,2})?",
      "title": "Net Amount",
      "type": "string"
    },
    "currency": {
      "$ref": "#/$defs/CurrencyEnum",
      "description": "Currency code in ISO 4217 format. E.g. 'NOK'"
    },
    "discount_amount": {
      "default": "0.00",
      "deprecated": true,
      "description": "Deprecated, discount amount is only applicable at line item level",
      "format": "decimal",
      "pattern": "^-?[0-9]+(\\.[0-9]{0,2})?",
      "title": "Discount Amount",
      "type": "string"
    },
    "discount_rate": {
      "default": "0.000000",
      "deprecated": true,
      "description": "Deprecated, discount rate is only applicable at line item level",
      "format": "decimal",
      "pattern": "^-?[0-9]+(\\.[0-9]{0,6})?",
      "title": "Discount Rate",
      "type": "string"
    },
    "tax_amount": {
      "description": "Total tax (e.g. VAT) applied to the order.",
      "format": "decimal",
      "pattern": "^-?[0-9]+(\\.[0-9]{0,2})?",
      "title": "Tax Amount",
      "type": "string"
    },
    "buyer_department": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Department the purchase is to be registered on",
      "title": "Buyer Department"
    },
    "buyer_project": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Project the purchase is to be registered on",
      "title": "Buyer Project"
    },
    "buyer_purchase_order_number": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Purchase order number to attribute to the order",
      "title": "Buyer Purchase Order Number"
    },
    "buyer_reference": {
      "anyOf": [
        {
          "maxLength": 140,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "General buyer reference field for information that is not covered by the specific reference fields, e.g. PO-number. Note: Maximum 140 characters",
      "title": "Buyer Reference"
    },
    "buyer_vat_number": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Vat number associated with the buyer company",
      "title": "Buyer Vat Number"
    },
    "line_items": {
      "description": "List of the line items that constitute the order",
      "items": {
        "$ref": "#/$defs/LineItemRequestSchema"
      },
      "title": "Line Items",
      "type": "array"
    },
    "merchant_order_id": {
      "description": "Your order ID to register against the order",
      "title": "Merchant Order Id",
      "type": "string"
    },
    "merchant_reference": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Field set by merchant for adding a reference to be used internally by the merchant. Does not appear on invoice.",
      "title": "Merchant Reference"
    },
    "merchant_additional_info": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Additional info the merchant can connect to the order",
      "title": "Merchant Additional Info"
    },
    "invoice_details": {
      "anyOf": [
        {
          "$ref": "#/$defs/InvoiceDetailsRequestSchema"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Invoice details are provided by the merchant via Merchant Portal when invoice_type is DIRECT_INVOICE, Two Bank or a 3rd-party bank when invoice_type is FUNDED_INVOICE and empty when invoice_type is CARD."
    },
    "merchant_short_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "deprecated": true,
      "description": "Deprecated. Use merchant_id where possible.",
      "title": "Merchant Short Name"
    },
    "shipping_details": {
      "anyOf": [
        {
          "$ref": "#/$defs/ShippingDetailsSchema"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Shipping details including carrier information and delivery method. For merchants offering multiple fulfillment options, the `delivery_method` field is needed for order validation and processing workflow purposes."
    },
    "order_note": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "General note/message from the buyer to the merchant",
      "title": "Order Note"
    },
    "billing_address": {
      "anyOf": [
        {
          "$ref": "#/$defs/CreateAddressRequestSchema"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Order billing address"
    },
    "shipping_address": {
      "anyOf": [
        {
          "$ref": "#/$defs/CreateAddressRequestSchema"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Order shipping address"
    },
    "tax_subtotals": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/TaxSubtotalSchema"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "List of tax subtotals for unique tax brackets",
      "title": "Tax Subtotals"
    },
    "terms": {
      "anyOf": [
        {
          "description": "For backwards compatibility, `type` can be omitted for instalment terms, if the fields period and number_of_instalments are populated. It is recommended that that clients always provide a type value.",
          "oneOf": [
            {
              "$ref": "#/$defs/OrderInstalmentTerms"
            },
            {
              "$ref": "#/$defs/OrderNetTerms"
            }
          ]
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "If set, the order will be placed with the specified terms. This is in beta and only open for limited users. Please contact us if you would like to integrate with this feature. It cannot be used with invoice_details.due_date, invoice_details.due_in_days and invoice_details.invoice_issue_date.",
      "title": "Terms"
    },
    "merchant_invoice_branding_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "ID of the merchant's invoice branding configuration",
      "title": "Merchant Invoice Branding Id"
    },
    "merchant_invoice_store_branding_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "ID of the merchant's store-specific invoice branding configuration",
      "title": "Merchant Invoice Store Branding Id"
    },
    "order_placed_date": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Date order was placed (UTC). If not specified, defaults to current timestamp.",
      "title": "Order Placed Date"
    },
    "order_type": {
      "anyOf": [
        {
          "$ref": "#/$defs/OrderTypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Type of order (Buyer or Merchant initiated)"
    },
    "sale_country_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional sale country code (ISO 3166 Alpha-2) to use for this order, if null defaults to buyer country code.",
      "title": "Sale Country Code"
    },
    "merchant_payout_account_alias": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional payee account alias account identifier for multiple accounts setup.",
      "title": "Merchant Payout Account Alias"
    },
    "recurring": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "If set to true, an invoice will be generated periodically according to the specification provided in recurring_details",
      "title": "Recurring"
    },
    "merchant_invoice_branding_reference": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Reference to merchant's invoice branding configuration",
      "title": "Merchant Invoice Branding Reference"
    },
    "merchant_invoice_store_branding_reference": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Reference to merchant's store-specific invoice branding configuration",
      "title": "Merchant Invoice Store Branding Reference"
    },
    "buyer": {
      "anyOf": [
        {
          "$ref": "#/$defs/NonStrictBuyerSchema"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Fields representing the buyer"
    },
    "electronic_invoice_recipient": {
      "anyOf": [
        {
          "$ref": "#/$defs/ElectronicInvoiceRecipient"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "electronic_invoice_recipient"
    },
    "preferred_distribution_method": {
      "anyOf": [
        {
          "$ref": "#/$defs/DistributionMethodEnum"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Allows merchant to set the method of distribution for the invoice and credit notes of the order, if not set will default to all methods"
    },
    "recurring_details": {
      "anyOf": [
        {
          "$ref": "#/$defs/RecurringDetailsSchema"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Currently not available"
    },
    "merchant_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "A globally unique merchant ID set by Two.",
      "title": "Merchant Id"
    },
    "merchant_urls": {
      "anyOf": [
        {
          "$ref": "#/$defs/CreateOrderMerchantUrlsSchema"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "List of urls hosted by the merchant."
    },
    "order_origination": {
      "anyOf": [
        {
          "$ref": "#/$defs/OrderOriginationEnum"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "IN_STORE orders are not enabled by default. Please reach out to us if you would like to discuss IN_STORE orders."
    },
    "tracking_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Tracking ID from `POST /order_intent`",
      "title": "Tracking Id"
    },
    "vendor_name": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "This is an optional vendor name that is used to refer to the seller in a marketplace setup.",
      "title": "Vendor Name"
    },
    "vendor_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional vendor ID for your reference",
      "title": "Vendor Id"
    },
    "merchant_user_id": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Your internal ID of the user (the employee of your business customer) registered for one-click purchase through the Two Trade Account Onboarding API.",
      "title": "Merchant User Id"
    },
    "billing_account_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "ID for the billing account linked to this order. Do not pass terms when setting billing_account_id; billing account payment terms take precedence. The billing account buyer company must match the order buyer company. The billing account must belong to the same merchant as the order. Cannot be combined with INSTALMENTS terms or terms.duration_days_calculated_from.",
      "title": "Billing Account Id"
    },
    "disallow_portal_mutation": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "If set to true, state-mutating actions (fulfill, cancel, refund) cannot be performed on this order through the merchant portal. Use this for orders managed by external systems (ERPs, PSPs) that track order state via the API, to prevent desynchronization.",
      "title": "Disallow Portal Mutation"
    },
    "credit_line_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "ID of the credit line used to fund the order, created through the Two Credit Line API.",
      "title": "Credit Line Id"
    }
  },
  "required": [
    "billing_address",
    "buyer",
    "currency",
    "gross_amount",
    "line_items",
    "merchant_order_id",
    "net_amount",
    "tax_amount",
    "tax_subtotals"
  ],
  "type": "object",
  "$defs": {
    "BankAccountSchema": {
      "properties": {
        "id": {
          "anyOf": [
            {
              "format": "uuid",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "bban": {
          "anyOf": [
            {
              "maxLength": 30,
              "minLength": 7,
              "pattern": "^[0-9A-Za-z]*$",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Bban"
        },
        "iban": {
          "anyOf": [
            {
              "maxLength": 34,
              "minLength": 15,
              "pattern": "^[0-9A-Za-z]*$",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Iban"
        },
        "bic": {
          "anyOf": [
            {
              "maxLength": 12,
              "minLength": 8,
              "pattern": "^[0-9A-Za-z]*$",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Bic"
        },
        "country_code": {
          "anyOf": [
            {
              "$ref": "#/$defs/CountryCodeEnum"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        },
        "branch_sort_code": {
          "anyOf": [
            {
              "maxLength": 9,
              "pattern": "^[0-9]*$",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Branch Sort Code"
        },
        "local_account_number": {
          "anyOf": [
            {
              "maxLength": 12,
              "minLength": 8,
              "pattern": "^[0-9]*$",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Local Account Number"
        },
        "organization_name": {
          "anyOf": [
            {
              "maxLength": 140,
              "minLength": 1,
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Organization Name"
        },
        "organization_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Organization Number"
        },
        "description": {
          "anyOf": [
            {
              "maxLength": 255,
              "minLength": 1,
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "kid_type": {
          "anyOf": [
            {
              "$ref": "#/$defs/KidTypeEnum"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        }
      },
      "title": "BankAccountSchema",
      "type": "object"
    },
    "BarCodeSchema": {
      "properties": {
        "value": {
          "description": "The identifier as a string",
          "title": "Value",
          "type": "string"
        },
        "type": {
          "description": "Type of the identifier. Can be either \"SKU\" or a Global Trade Item Number (GTIN) type like \"UPC\", \"EAN\", \"GS1\".",
          "title": "Type",
          "type": "string"
        }
      },
      "required": [
        "value",
        "type"
      ],
      "title": "BarCodeSchema",
      "type": "object"
    },
    "CallbackAuthTypeEnum": {
      "enum": [
        "BEARER"
      ],
      "title": "CallbackAuthTypeEnum",
      "type": "string"
    },
    "CompanyCanonicalIdSchema": {
      "additionalProperties": false,
      "description": "A schema that represents a company only by its canonical ID.\nIntended for use in requests to our API to create order intents and orders.\nUse the Two Company Search API to retrieve the canonical_id for a company.\n\nIMPORTANT: This schema forbids extra fields to prevent silent data loss.\nIf additional company fields are provided, use CompanySchema instead.",
      "properties": {
        "company_canonical_id": {
          "description": "Unique canonical ID representing this company. Retrieve this from the Two Company Search API.",
          "pattern": "^[a-zA-Z0-9]+$",
          "title": "Company Canonical Id",
          "type": "string"
        }
      },
      "required": [
        "company_canonical_id"
      ],
      "title": "CompanyCanonicalIdSchema",
      "type": "object"
    },
    "CompanySchema": {
      "description": "Standard company schema with required fields for full company identification.\nExtends NonStrictCompanySchema and makes key fields required.",
      "properties": {
        "id": {
          "anyOf": [
            {
              "format": "uuid",
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Internal company Id",
          "title": "Id"
        },
        "country_prefix": {
          "$ref": "#/$defs/CountryCodeEnum",
          "description": "Country code in ISO 3166-1 alpha-2 format"
        },
        "organization_number": {
          "description": "National id of the buyer company",
          "title": "Organization Number",
          "type": "string"
        },
        "company_name": {
          "default": null,
          "description": "Legal name of the buyer company",
          "maxLength": 255,
          "minLength": 1,
          "title": "Company Name",
          "type": "string"
        },
        "company_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Type of company placing the order",
          "title": "Company Type"
        },
        "company_canonical_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Unique canonical ID representing this company",
          "title": "Company Canonical Id"
        },
        "website": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Company's website",
          "title": "Website"
        }
      },
      "required": [
        "country_prefix",
        "organization_number"
      ],
      "title": "CompanySchema",
      "type": "object"
    },
    "CountryCodeEnum": {
      "enum": [
        "AD",
        "AE",
        "AL",
        "AM",
        "AO",
        "AR",
        "AT",
        "AU",
        "AZ",
        "BA",
        "BB",
        "BD",
        "BE",
        "BF",
        "BG",
        "BH",
        "BI",
        "BJ",
        "BN",
        "BO",
        "BR",
        "BS",
        "BW",
        "CA",
        "CG",
        "CH",
        "CL",
        "CM",
        "CO",
        "CR",
        "CY",
        "CZ",
        "DE",
        "DJ",
        "DK",
        "DO",
        "DZ",
        "EC",
        "EE",
        "EG",
        "ES",
        "ET",
        "FI",
        "FJ",
        "FR",
        "GA",
        "GB",
        "GE",
        "GH",
        "GN",
        "GQ",
        "GR",
        "GT",
        "GY",
        "HN",
        "HR",
        "HT",
        "HU",
        "ID",
        "IE",
        "IL",
        "IN",
        "IQ",
        "IS",
        "IT",
        "JM",
        "JO",
        "JP",
        "KE",
        "KG",
        "KH",
        "KR",
        "KW",
        "KZ",
        "LA",
        "LB",
        "LI",
        "LK",
        "LT",
        "LU",
        "LV",
        "LR",
        "MA",
        "MC",
        "MD",
        "ME",
        "MG",
        "MK",
        "MN",
        "MR",
        "MT",
        "MU",
        "MV",
        "MW",
        "MX",
        "MY",
        "MZ",
        "NA",
        "NE",
        "NG",
        "NL",
        "NO",
        "NP",
        "NZ",
        "OM",
        "PA",
        "PE",
        "PG",
        "PH",
        "PK",
        "PL",
        "PT",
        "PY",
        "QA",
        "RO",
        "RS",
        "RW",
        "SA",
        "SE",
        "SG",
        "SI",
        "SK",
        "SL",
        "SN",
        "SR",
        "SV",
        "SZ",
        "TD",
        "TG",
        "TH",
        "TJ",
        "TM",
        "TN",
        "TR",
        "TT",
        "TZ",
        "UA",
        "UG",
        "US",
        "UY",
        "UZ",
        "VN",
        "ZA",
        "ZM"
      ],
      "title": "CountryCodeEnum",
      "type": "string"
    },
    "CreateAddressRequestSchema": {
      "properties": {
        "organization_name": {
          "title": "Organization Name",
          "type": "string"
        },
        "street_address": {
          "maxLength": 255,
          "title": "Street Address",
          "type": "string"
        },
        "country": {
          "$ref": "#/$defs/CountryCodeEnum"
        },
        "postal_code": {
          "title": "Postal Code",
          "type": "string"
        },
        "city": {
          "title": "City",
          "type": "string"
        },
        "region": {
          "default": "",
          "title": "Region",
          "type": "string"
        }
      },
      "required": [
        "organization_name",
        "street_address",
        "country",
        "postal_code",
        "city"
      ],
      "title": "CreateAddressRequestSchema",
      "type": "object"
    },
    "CreateOrderMerchantUrlsSchema": {
      "description": "Request-side merchant URLs: enforces an http(s) scheme on inbound URLs.\n\nThe scheme validators live here rather than on OrderMerchantUrlsSchema so\nthey only run when parsing a request body. Response schemas\n(OrderResponseSchema, VerifyUserResponseSchema) embed the plain\nOrderMerchantUrlsSchema and must never re-validate stored URLs on read - a\nlegacy or schemeless value persisted before this rule existed would\notherwise break order reads (ISEC-87).",
      "properties": {
        "merchant_confirmation_url": {
          "description": "URL to which you want to redirect your users upon successful order verification.",
          "title": "Merchant Confirmation Url",
          "type": "string"
        },
        "merchant_cancel_order_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "URL to which you want to redirect your users when they cancel an order.",
          "title": "Merchant Cancel Order Url"
        },
        "merchant_edit_order_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Merchant Edit Order Url"
        },
        "merchant_order_verification_pending_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Merchant Order Verification Pending Url"
        },
        "merchant_order_verification_failed_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Merchant Order Verification Failed Url"
        },
        "merchant_invoice_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Merchant Invoice Url"
        },
        "merchant_shipping_document_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Merchant Shipping Document Url"
        },
        "merchant_document_urls": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Merchant Document Urls"
        },
        "merchant_order_verified_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Merchant Order Verified Url"
        },
        "merchant_order_callback_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Merchant Order Callback Url"
        },
        "merchant_order_callback_auth": {
          "anyOf": [
            {
              "$ref": "#/$defs/OrderMerchantCallbackAuthSchema"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        }
      },
      "required": [
        "merchant_confirmation_url"
      ],
      "title": "CreateOrderMerchantUrlsSchema",
      "type": "object"
    },
    "CurrencyEnum": {
      "enum": [
        "CHF",
        "CZK",
        "DKK",
        "EUR",
        "GBP",
        "INR",
        "MXN",
        "NOK",
        "PLN",
        "RON",
        "SEK",
        "USD"
      ],
      "title": "CurrencyEnum",
      "type": "string"
    },
    "DeliveryMethodEnum": {
      "description": "Enum for types of shipping methods",
      "enum": [
        "PICKUP_STORE",
        "PICKUP_POINT",
        "DELIVERED_TO_SHIPPING_ADDRESS",
        "DELIVERED_DIGITALLY",
        "EXPRESS_PICKUP_POINT",
        "EXPRESS_SHIPPING_ADDRESS",
        "OTHER"
      ],
      "title": "DeliveryMethodEnum",
      "type": "string"
    },
    "DistributionMethodEnum": {
      "enum": [
        "EMAIL",
        "ELECTRONIC_INVOICE"
      ],
      "title": "DistributionMethodEnum",
      "type": "string"
    },
    "DueDateCalculationScheme": {
      "description": "Scheme for calculating invoice due dates for orders.\nWhen set, modifies the due_in_days calculation based on the scheme type.",
      "enum": [
        "END_OF_MONTH",
        "END_OF_WEEK"
      ],
      "title": "DueDateCalculationScheme",
      "type": "string"
    },
    "ElectronicInvoiceRecipient": {
      "properties": {
        "id": {
          "title": "Id",
          "type": "string"
        },
        "type": {
          "$ref": "#/$defs/ElectronicInvoiceRecipientTypeEnum"
        },
        "operator_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Operator Id"
        }
      },
      "required": [
        "id",
        "type"
      ],
      "title": "ElectronicInvoiceRecipient",
      "type": "object"
    },
    "ElectronicInvoiceRecipientTypeEnum": {
      "enum": [
        "NO_ORGNUMBER",
        "SE_ORGNUMBER",
        "GLN",
        "DK_ORGNUMBER",
        "FI_ORGNUMBER",
        "FINVOICE"
      ],
      "title": "ElectronicInvoiceRecipientTypeEnum",
      "type": "string"
    },
    "InvoiceDetailsRequestSchema": {
      "properties": {
        "payee": {
          "anyOf": [
            {
              "$ref": "#/$defs/BankAccountSchema"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        },
        "payment_reference": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Payment Reference"
        },
        "payment_reference_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Payment Reference Type"
        },
        "payment_reference_message": {
          "default": "",
          "description": "Text that will be attached to the payment in order for the merchant to recon

# --- truncated at 32 KB (55 KB total) ---
# Full source: https://artifacts.apis.io/two/json-schema/two-create-order-request-schema-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/two-create-order-request-schema"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.