OrderFields

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/jumpseller-com/json-schema/jumpseller-com-order-fields-schema.json",
  "title": "OrderFields",
  "x-generated": "2026-11-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/jumpseller-com-openapi.json#/components/schemas/OrderFields",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique identifier of the Order",
      "format": "int32"
    },
    "source": {
      "$ref": "#/$defs/TrafficSource"
    },
    "created_at": {
      "type": "string",
      "description": "Order date"
    },
    "completed_at": {
      "type": "string",
      "description": "The date when the order was first completed."
    },
    "currency": {
      "type": "string",
      "description": "Currency of the Order"
    },
    "subtotal": {
      "type": "number",
      "description": "Subtotal value for the given Order. Excluding taxes, shipping and discounts",
      "format": "float"
    },
    "tax": {
      "type": "number",
      "description": "Tax value for the given order",
      "format": "float"
    },
    "shipping_tax": {
      "type": "number",
      "description": "Shipping Tax value for the given order",
      "format": "float"
    },
    "shipping": {
      "type": "number",
      "description": "Shipping value for the given Order",
      "format": "float"
    },
    "shipping_required": {
      "type": "boolean",
      "description": "False if the order is digital.",
      "default": true
    },
    "total": {
      "type": "number",
      "description": "Total value for the given Order. Including taxes, shipping and discounts",
      "format": "float"
    },
    "discount": {
      "type": "number",
      "description": "Discount value for the given Order",
      "format": "float"
    },
    "shipping_discount": {
      "type": "number",
      "description": "Shipping Discount value for the given order",
      "format": "float"
    },
    "gift_cards_discount": {
      "type": "number",
      "description": "Gift Cards Discount value for the given order",
      "format": "float"
    },
    "fulfillment_status": {
      "type": "string",
      "description": "Fulfillment Status for Order.",
      "enum": [
        "unfulfilled",
        "partial",
        "fulfilled"
      ]
    },
    "shipping_method_id": {
      "type": "integer",
      "description": "Shipping method e.g. Royal Mail",
      "format": "int32"
    },
    "shipping_service_id": {
      "type": "integer",
      "description": "Shipping service",
      "format": "int32"
    },
    "shipping_method_name": {
      "type": "string",
      "description": "Shipping method e.g. Royal Mail"
    },
    "payment_method_name": {
      "type": "string",
      "description": "Payment Method name used e.g. PayPal"
    },
    "payment_method_type": {
      "type": "string",
      "description": "Payment Method type used e.g. paypal"
    },
    "payment_information": {
      "type": "string",
      "description": "Payment information for the given Order"
    },
    "payment_notification_id": {
      "type": "string",
      "description": "Payment notification identifier"
    },
    "additional_information": {
      "type": "string",
      "description": "Additional information for the given Order"
    },
    "duplicate_url": {
      "type": "string",
      "description": "Duplicate Order URL for the given Order"
    },
    "recovery_url": {
      "type": "string",
      "description": "Recovery Order URL for the given Order"
    },
    "review_url": {
      "type": "string",
      "description": "Review Order URL for the given Order"
    },
    "checkout_url": {
      "type": "string",
      "description": "Store Checkout Order URL for the given Order"
    },
    "coupons": {
      "type": "string",
      "description": "Promotion Coupons used on the given Order, separated by commas"
    },
    "promotions": {
      "type": "array",
      "description": "Promotions used on the given Order",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Id of the Promotion"
          },
          "name": {
            "type": "string"
          },
          "code": {
            "type": [
              "string",
              "null"
            ],
            "description": "Coupon code used, if any"
          }
        }
      }
    },
    "customer": {
      "$ref": "#/$defs/CustomerSimpleFields"
    },
    "shipping_branch": {
      "$ref": "#/$defs/OrderShippingBranch"
    },
    "shipping_address": {
      "$ref": "#/$defs/OrderShippingAddress"
    },
    "billing_address": {
      "$ref": "#/$defs/OrderBillingAddress"
    },
    "pickup_address": {
      "$ref": "#/$defs/OrderPickupAddress"
    },
    "products": {
      "type": "array",
      "description": "Products of the Order. Deposits and other fees are not product lines: read them from `fees`.",
      "items": {
        "$ref": "#/$defs/OrderProduct"
      }
    },
    "additional_fields": {
      "type": "array",
      "description": "Array of additional fields for the given Order",
      "items": {
        "$ref": "#/$defs/OrderAdditionalFields"
      }
    },
    "shipping_taxes": {
      "type": "array",
      "description": "Taxes applied to shipping (returned with the `taxes` field)",
      "items": {
        "$ref": "#/$defs/OrderShippingTax"
      }
    },
    "fees": {
      "type": "array",
      "description": "Fees charged apart from products, shipping and tax, like packaging deposits. They are added to `total` and are not part of `tax`.",
      "items": {
        "$ref": "#/$defs/OrderFee"
      }
    },
    "status": {
      "type": "string",
      "description": "Status of the Order.",
      "enum": [
        "Created",
        "Abandoned",
        "Canceled",
        "Pending Payment",
        "Paid"
      ]
    },
    "status_name": {
      "type": "string",
      "description": "Status of the Order (same value as `status`).",
      "enum": [
        "Created",
        "Abandoned",
        "Canceled",
        "Pending Payment",
        "Paid"
      ]
    },
    "tracking_url": {
      "type": "string",
      "description": "Tracking URL for Order Fulfillment."
    },
    "tracking_company": {
      "type": "string",
      "description": "Company Used for Order Fulfillment."
    },
    "tracking_number": {
      "type": "string",
      "description": "Tracking Number for Order Fulfillment."
    },
    "shipping_option": {
      "type": [
        "string",
        "null"
      ],
      "description": "Shipping option for this order.",
      "enum": [
        "delivery",
        "store_pickup",
        "no_shipping",
        "point_pickup"
      ]
    },
    "same_day_delivery": {
      "type": "boolean",
      "description": "True if same day delivery was selected for the order, false otherwise.",
      "default": false
    },
    "shipment_status": {
      "type": "string",
      "description": "Shipment Status for Order and Order Fulfillment, translated to the request locale, e.g. `Delivered`, `In Transit`, `Unfulfilled` or `Not Applicable`. Use `shipment_status_enum` for a stable value."
    },
    "shipment_status_enum": {
      "type": "string",
      "description": "Shipment Status for Order and Order Fulfillment (enum). `fulfilled` is a fulfillment without a shipment status; `not_applicable` an Order without shipping.",
      "enum": [
        "unfulfilled",
        "requested",
        "in_transit",
        "delivered",
        "failed",
        "pickup_available",
        "in_preparation",
        "fulfilled",
        "not_applicable"
      ]
    },
    "recovered_from": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Id of the Order this Order was recovered from",
      "format": "int32"
    },
    "external_shipping_rate_id": {
      "type": "string",
      "description": "Rate id for selected External Shipping Method rate"
    },
    "external_shipping_rate_description": {
      "type": "string",
      "description": "Rate description for selected External Shipping Method rate"
    },
    "billing_information": {
      "$ref": "#/$defs/BillingInformationFields"
    },
    "cart_id": {
      "type": "integer",
      "format": "int32",
      "description": "Internal id of the Order, used as the cart id by `GET /carts/{id}.json`. Only returned when requested with `fields`."
    }
  },
  "$defs": {
    "BillingInformationFields": {
      "type": "object",
      "properties": {
        "business_activity": {
          "type": "string",
          "description": "Giro"
        },
        "company_name": {
          "type": "string",
          "description": "Razon Social"
        },
        "taxpayer_type": {
          "type": "string",
          "description": "Tipo de Contribuinte"
        }
      }
    },
    "CustomerSimpleFields": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Unique identifier of the Customer",
          "format": "int32"
        },
        "email": {
          "type": "string",
          "description": "Email of the Customer"
        },
        "phone": {
          "type": "string",
          "description": "Phone of the Customer"
        },
        "phone_prefix": {
          "type": "string",
          "description": "Phone prefix of the Customer"
        },
        "ip": {
          "type": "string",
          "description": "IP of the Customer"
        },
        "fullname": {
          "type": "string",
          "description": "Customer fullname retrieved from the default billing address. Defaults to customer email if no name is found."
        }
      }
    },
    "OrderAdditionalFields": {
      "type": "object",
      "properties": {
        "label": {
          "type": "string",
          "description": "Label of the additional field",
          "format": "string"
        },
        "value": {
          "type": "string",
          "description": "Value of the additional field",
          "format": "string"
        },
        "id": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Id of the checkout custom field, if any. Ignored on create and update.",
          "format": "int32"
        },
        "area": {
          "type": "string",
          "description": "Area of the additional field",
          "enum": [
            "contact",
            "shipping",
            "billing",
            "other"
          ]
        }
      },
      "description": "Additional field of an order"
    },
    "OrderBillingAddress": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the Order's Billing Address"
        },
        "surname": {
          "type": "string",
          "description": "Surname of the Order's Billing Address"
        },
        "taxid": {
          "type": "string",
          "description": "TaxID of the Order's Billing Address"
        },
        "address": {
          "type": "string",
          "description": "Address of the Order's Billing Address"
        },
        "city": {
          "type": "string",
          "description": "City of the Order's Billing Address"
        },
        "postal": {
          "type": "string",
          "description": "Postal code of the Order's Billing Address"
        },
        "region": {
          "type": "string",
          "description": "Region name of the Order's Billing Address"
        },
        "country": {
          "type": "string",
          "description": "Country name of the Order's Billing Address"
        },
        "country_code": {
          "type": "string",
          "description": "Country code of the Order's Billing Address (ISO 3166-1 alpha-2)"
        },
        "region_code": {
          "type": "string",
          "description": "Region code of the Order's Billing Address (Use the FIPS standard - http://www.geonames.org/countries/)"
        },
        "street_number": {
          "type": "string",
          "description": "Street number of the Order's Billing Address"
        },
        "complement": {
          "type": "string",
          "description": "Complement of the Order's Billing Address"
        },
        "municipality": {
          "type": "string",
          "description": "Municipality of the Order's Billing Address"
        },
        "neighbourhood": {
          "type": "string",
          "description": "Third level of administrative subdivision of the Order's Billing Address used only for some countries (e.g. Mexico)"
        }
      }
    },
    "OrderFee": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Unique identifier of the Order Fee",
          "format": "int32"
        },
        "kind": {
          "type": "string",
          "description": "Kind of fee",
          "enum": [
            "deposit"
          ]
        },
        "name": {
          "type": "string",
          "description": "Fee name"
        },
        "order_product_id": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Product line of the Order the fee is charged on. `null` when it applies to the whole Order.",
          "format": "int32"
        },
        "rate": {
          "type": "number",
          "description": "Amount per unit, or a percentage of the unit price before tax when `fixed` is false",
          "format": "float"
        },
        "fixed": {
          "type": "boolean",
          "description": "False if rate is a percentage and true if rate is monetary",
          "default": true
        },
        "quantity": {
          "type": "integer",
          "description": "Number of units charged",
          "format": "int32"
        },
        "amount": {
          "type": "number",
          "description": "Fee amount for the whole line, before tax",
          "format": "float"
        },
        "tax_amount": {
          "type": "number",
          "description": "Tax charged on the fee. Always 0 for now: once fees can be taxed, it will also be counted in the Order `tax`.",
          "format": "float"
        }
      }
    },
    "OrderPickupAddress": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the Order's Pickup Address"
        },
        "surname": {
          "type": "string",
          "description": "Surname of the Order's Pickup Address"
        },
        "address": {
          "type": "string",
          "description": "Address of the Order's Pickup Address"
        },
        "city": {
          "type": "string",
          "description": "City of the Order's Pickup Address"
        },
        "postal": {
          "type": "string",
          "description": "Postal code of the Order's Pickup Address"
        },
        "region": {
          "type": "string",
          "description": "Region name of the Order's Pickup Address"
        },
        "country": {
          "type": "string",
          "description": "Country name of the Order's Pickup Address"
        },
        "country_code": {
          "type": "string",
          "description": "Country code of the Order's Pickup Address (ISO 3166-1 alpha-2)"
        },
        "region_code": {
          "type": "string",
          "description": "Region code of the Order's Pickup Address (Use the FIPS standard - http://www.geonames.org/countries/)"
        },
        "street_number": {
          "type": "string",
          "description": "Street number of the Order's Pickup Address"
        },
        "complement": {
          "type": "string",
          "description": "Complement of the Order's Pickup Address"
        },
        "municipality": {
          "type": "string",
          "description": "Municipality of the Order's Pickup Address"
        },
        "pickup_place_name": {
          "type": "string",
          "description": "Name of the Pickup Place"
        },
        "taxid": {
          "type": "string",
          "description": "TaxID of the Order's Pickup Address"
        },
        "neighbourhood": {
          "type": "string",
          "description": "Third level of administrative subdivision used only for some countries (e.g. Mexico)"
        }
      }
    },
    "OrderProduct": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Unique identifier of the original Product",
          "format": "int32"
        },
        "order_product_id": {
          "type": "integer",
          "description": "Unique identifier of the product line in the Order",
          "format": "int32"
        },
        "bundle_order_product_id": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Identifier of the bundle product line that contains this product line",
          "format": "int32"
        },
        "variant_id": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Unique identifier of the original Product Variant",
          "format": "int32"
        },
        "sku": {
          "type": "string",
          "description": "Stock Keeping Unit of the Order Product"
        },
        "name": {
          "type": "string",
          "description": "Name of the Order Product, including the selected options"
        },
        "qty": {
          "type": "integer",
          "description": "Quantity of the Order Product",
          "format": "int32"
        },
        "price": {
          "type": "number",
          "description": "Price of the Order Product",
          "format": "float"
        },
        "tax": {
          "type": [
            "number",
            "null"
          ],
          "description": "Tax of the Order Product",
          "format": "float"
        },
        "discount": {
          "type": "number",
          "description": "Discount of the Order Product",
          "format": "float"
        },
        "weight": {
          "type": "number",
          "description": "Weight of the Order Product",
          "format": "float",
          "default": 1
        },
        "image": {
          "type": [
            "string",
            "null"
          ],
          "description": "Image URL of the Order Product"
        },
        "type": {
          "type": "string",
          "description": "Type of the Order Product",
          "enum": [
            "physical",
            "digital",
            "gift_card",
            "appointment",
            "bundle"
          ]
        },
        "taxes": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OrderProductTax"
          }
        },
        "options": {
          "type": "array",
          "description": "Options selected for the Order Product",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "value": {
                "type": "string"
              },
              "addon_price": {
                "type": "number",
                "format": "float"
              }
            }
          }
        },
        "stock_locations": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/OrderProductStockLocations"
          }
        },
        "files": {
          "type": "array",
          "description": "Files uploaded by the customer for file options",
          "items": {
            "type": "object",
            "properties": {
              "option": {
                "type": "string",
                "description": "Name of the file option"
              },
              "url": {
                "type": "string",
                "description": "Temporary URL of the file"
              }
            }
          }
        }
      }
    },
    "OrderProductStockLocations": {
      "type": "object",
      "properties": {
        "location_id": {
          "type": "integer",
          "description": "Unique identifier of the Order Product Location",
          "format": "int32"
        },
        "stock": {
          "type": "integer",
          "description": "Quantity in stock for the product at the location"
        }
      }
    },
    "OrderProductTax": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Unique identifier of the Order Product Tax",
          "format": "int32"
        },
        "name": {
          "type": "string",
          "description": "Name of the category that the tax is associated with or the tax name"
        },
        "rate": {
          "type": "number",
          "description": "Tax rate",
          "format": "float"
        },
        "fixed": {
          "type": "boolean",
          "description": "False if rate is a percentage and true if rate is monetary",
          "default": false
        },
        "tax_on_product_price": {
          "type": "boolean",
          "description": "False if tax is not included on product price",
          "default": false
        },
        "amount": {
          "type": "number",
          "description": "Tax amount charged on the Order Product",
          "format": "float"
        }
      }
    },
    "OrderShippingAddress": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the Order's Shipping Address"
        },
        "surname": {
          "type": "string",
          "description": "Surname of the Order's Shipping Address"
        },
        "address": {
          "type": "string",
          "description": "Address of the Order's Shipping Address"
        },
        "city": {
          "type": "string",
          "description": "City of the Order's Shipping Address"
        },
        "postal": {
          "type": "string",
          "description": "Postal code of the Order's Shipping Address"
        },
        "region": {
          "type": "string",
          "description": "Region name of the Order's Shipping Address"
        },
        "country": {
          "type": "string",
          "description": "Country name of the Order's Shipping Address"
        },
        "country_code": {
          "type": "string",
          "description": "Country code of the Order's Shipping Address (ISO 3166-1 alpha-2)"
        },
        "region_code": {
          "type": "string",
          "description": "Region code of the Order's Shipping Address (Use the FIPS standard - http://www.geonames.org/countries/)"
        },
        "street_number": {
          "type": "string",
          "description": "Street number of the Order's Shipping Address"
        },
        "complement": {
          "type": "string",
          "description": "Complement of the Order's Shipping Address"
        },
        "latitude": {
          "type": "number",
          "description": "Latitude of the Order's Shipping Address"
        },
        "longitude": {
          "type": "number",
          "description": "Longitude of the Order's Shipping Address"
        },
        "municipality": {
          "type": "string",
          "description": "Municipality of the Order's Shipping Address"
        },
        "neighbourhood": {
          "type": "string",
          "description": "Third level of administrative subdivision of the Customer's Shipping Address used only for some countries (e.g. Mexico)"
        }
      }
    },
    "OrderShippingBranch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "ID of the Order's Shipping Branch",
          "format": "int32"
        },
        "name": {
          "type": "string",
          "description": "Name of the Order's Shipping Branch"
        }
      }
    },
    "OrderShippingTax": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Unique identifier of the Order Shipping Tax",
          "format": "int32"
        },
        "name": {
          "type": "string",
          "description": "Tax name"
        },
        "rate": {
          "type": "number",
          "description": "Tax rate",
          "format": "float"
        },
        "fixed": {
          "type": "boolean",
          "description": "False if rate is a percentage and true if rate is monetary",
          "default": false
        },
        "amount": {
          "type": "number",
          "description": "Tax amount charged on shipping",
          "format": "float"
        },
        "tax_on_shipping_price": {
          "type": "boolean",
          "description": "False if shipping tax is not included on shipping price",
          "default": false
        }
      }
    },
    "TrafficSource": {
      "type": "object",
      "properties": {
        "created_from": {
          "type": "string",
          "description": "From where the order was created: [checkout, api, admin, duplicate, recovery, pos]"
        },
        "created_from_app_code": {
          "type": "string",
          "description": "The code of the app that created the order if it was created by an app through the API"
        },
        "source_name": {
          "type": "string",
          "description": "Where the checkout originated"
        },
        "medium": {
          "type": "string",
          "description": "The medium that referred the customer to the checkout"
        },
        "campaign": {
          "type": "string",
          "description": "The campaign that referred the customer to the checkout"
        },
        "referral_url": {
          "type": "string",
          "description": "The website that referred the customer to the checkout"
        },
        "referral_code": {
          "type": "string",
          "description": "The code that referred the customer to the checkout"
        },
        "user_agent": {
          "type": "string",
          "description": "User agent of the referred request to checkout"
        },
        "first_page_visited": {
          "type": "string",
          "description": "The first url visited by the customer"
        },
        "first_page_visited_at": {
          "type": "string",
          "description": "The date when the customer visited the first page"
        },
        "referral_source": {
          "type": "string",
          "description": "The source that referred the customer to the website"
        }
      }
    }
  }
}