BigCommerce · Schema

order_Nate

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Properties

Name Type Description
orderId integer
cartId string
currency object
isTaxIncluded boolean
baseAmount number
discountAmount integer
orderAmount number
orderAmountAsInteger integer
shippingCostTotal integer
shippingCostBeforeDiscount integer
handlingCostTotal integer
coupons array
lineItems object
customerId integer
billingAddress object
status string
customerCanBeCreated boolean
hasDigitalItems boolean
isDownloadable boolean
isComplete boolean
customerMessage string
taxes array
taxTotal integer
View JSON Schema on GitHub

JSON Schema

bigcommerce-order-nate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/order_Nate",
  "title": "order_Nate",
  "type": "object",
  "properties": {
    "orderId": {
      "type": "integer"
    },
    "cartId": {
      "type": "string"
    },
    "currency": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "code": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        },
        "decimalPlaces": {
          "type": "integer"
        }
      }
    },
    "isTaxIncluded": {
      "type": "boolean"
    },
    "baseAmount": {
      "type": "number"
    },
    "discountAmount": {
      "type": "integer"
    },
    "orderAmount": {
      "type": "number"
    },
    "orderAmountAsInteger": {
      "type": "integer"
    },
    "shippingCostTotal": {
      "type": "integer"
    },
    "shippingCostBeforeDiscount": {
      "type": "integer"
    },
    "handlingCostTotal": {
      "type": "integer"
    },
    "coupons": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {}
      }
    },
    "lineItems": {
      "type": "object",
      "properties": {
        "physicalItems": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "productId": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "sku": {
                "type": "string"
              },
              "quantity": {
                "type": "integer"
              },
              "isTaxable": {
                "type": "boolean"
              },
              "imageUrl": {
                "type": "string"
              },
              "discounts": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {}
                }
              },
              "discountAmount": {
                "type": "integer"
              },
              "brand": {
                "type": "string",
                "description": "The product's brand."
              },
              "listPrice": {
                "type": "number"
              },
              "salePrice": {
                "type": "number"
              },
              "extendedListPrice": {
                "type": "number"
              },
              "extendedSalePrice": {
                "type": "number"
              },
              "extendedComparisonPrice": {
                "type": "number"
              },
              "categories": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {}
                }
              },
              "type": {
                "type": "string"
              },
              "variantId": {
                "type": "integer"
              }
            }
          }
        },
        "digitalItems": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {}
          }
        },
        "giftCertificates": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {}
          }
        }
      }
    },
    "customerId": {
      "type": "integer"
    },
    "billingAddress": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "company": {
          "type": "string"
        },
        "address1": {
          "type": "string"
        },
        "address2": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "stateOrProvince": {
          "type": "string"
        },
        "stateOrProvinceCode": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "countryCode": {
          "type": "string"
        },
        "postalCode": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "customFields": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {}
          }
        }
      }
    },
    "status": {
      "type": "string"
    },
    "customerCanBeCreated": {
      "type": "boolean"
    },
    "hasDigitalItems": {
      "type": "boolean"
    },
    "isDownloadable": {
      "type": "boolean"
    },
    "isComplete": {
      "type": "boolean"
    },
    "customerMessage": {
      "type": "string"
    },
    "taxes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "amount": {
            "type": "integer"
          }
        }
      }
    },
    "taxTotal": {
      "type": "integer"
    }
  },
  "x-internal": false
}