action jumpseller_get_orders_json { label: "Retrieve all Orders." provider: jumpseller method: GET path: "/orders.json" encoding: json output: { type: "array" items: { type: "object" properties: { order: { properties: { additional_fields: { type: "array" description: "Array of additional fields for the given Order" items: { type: "object" description: "Additional field of an order" properties: { label: { type: "string" format: "string" description: "Label of the additional field" } value: { type: "string" format: "string" description: "Value of the additional field" } } } } additional_information: { type: "string" description: "Additional information for the given Order" } billing_address: { properties: { address: { type: "string" description: "Address of the Order's Billing Address" } city: { type: "string" description: "City of the Order's Billing Address" } country: { type: "string" description: "Country code of the Order's Billing Address (ISO 3166-1 alpha-2)" } country_name: { type: "string" description: "Country name of the Order's Billing Address" } municipality: { type: "string" description: "Municipality of the Order's Billing Address" } name: { type: "string" description: "Name of the Order's Billing Address" } postal: { type: "string" description: "Postal code of the Order's Billing Address" } region: { type: "string" description: "Region code of the Order's Billing Address (Use the FIPS standard - http://www.geonames.org/countries/)" } street_number: { type: "number" description: "Street number of the Order's Billing Address" } surname: { type: "string" description: "Surname of the Order's Billing Address" } } } checkout_url: { type: "string" description: "Store Checkout Order URL for the given Order" } coupons: { type: "string" description: "Promotion Coupons used on the given Order" } created_at: { type: "string" description: "Order date" } currency: { type: "string" description: "Currency of the Order" } customer: { type: "object" properties: { customer: { type: "object" properties: { billing_address: { properties: { address: { type: "string" description: "Address of the Customer's Billing Address" } city: { type: "string" description: "City of the Customer's Billing Address" } country: { type: "string" description: "Country code of the Customer's Billing Address (ISO 3166-1 alpha-2)" } municipality: { type: "string" description: "Municipality of the Customer's Billing Address" } name: { type: "string" description: "Name of the Customer's Billing Address" } postal: { type: "string" description: "Postal code of the Customer's Billing Address" } region: { type: "string" description: "Region code of the Customer's Billing Address (Use the FIPS standard - http://www.geonames.org/countries/)" } surname: { type: "string" description: "Surname of the Customer's Billing Address" } taxid: { type: "string" description: "Tax id of the Customer's Billing Address" } } } customer_additional_fields: { type: "array" items: { type: "object" properties: { customer_additional_field: { type: "object" properties: { area: { type: "object" additionalProperties: true } checkout_custom_field_id: { type: "object" additionalProperties: true } customer_id: { type: "object" additionalProperties: true } id: { type: "object" additionalProperties: true } label: { type: "object" additionalProperties: true } value: { type: "object" additionalProperties: true } } } } } } customer_categories: { type: "array" items: { type: "object" properties: { category: { type: "object" properties: { code: { type: "object" additionalProperties: true } id: { type: "object" additionalProperties: true } name: { type: "object" additionalProperties: true } } } } } } email: { type: "string" description: "Email of the Customer" } id: { type: "integer" format: "int32" description: "Unique identifier of the Customer" } name: { type: "string" description: "Name of the Customer" } phone: { type: "string" description: "Phone of the Customer" } shipping_address: { properties: { address: { type: "string" description: "Address of the Customer's Shipping Address" } city: { type: "string" description: "City of the Customer's Shipping Address" } country: { type: "string" description: "Country code of the Customer's Shipping Address (ISO 3166-1 alpha-2)" } municipality: { type: "string" description: "Municipality of the Customer's Shipping Address" } name: { type: "string" description: "Name of the Customer's Shipping Address" } postal: { type: "string" description: "Postal code of the Customer's Shipping Address" } region: { type: "string" description: "Region code of the Customer's Shipping Address (Use the FIPS standard - http://www.geonames.org/countries/)" } surname: { type: "string" description: "Surname of the Customer's Shipping Address" } } } status: { type: "string" description: "Status of the Customer" enum: ["approved", "pending", "disabled"] } surname: { type: "string" description: "Surname of the Customer" } } } } } discount: { type: "number" format: "float" description: "Discount value for the given Order" } duplicate_url: { type: "string" description: "Duplicate Order URL for the given Order" } external_shipping_rate_id: { type: "string" description: "Rate id for selected External Shipping Method rate" } id: { type: "integer" format: "int32" description: "Unique identifier of the Order" } payment_information: { type: "string" description: "Payment information for the given Order" } 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" } products: { type: "array" items: { type: "object" properties: { discount: { type: "number" format: "float" description: "Discount of the Order Product" } id: { type: "integer" format: "int32" description: "Unique identifier of the original Product" } image: { type: "string" description: "Image URL of the Order Product" } name: { type: "string" description: "Name of the Order Product" } price: { type: "number" format: "float" description: "Price of the Order Product" } qty: { type: "integer" format: "int32" description: "Price of the Order Product" } sku: { type: "string" description: "Stock Keeping Unit of the Order Product" } taxes: { type: "array" items: { type: "object" properties: { fixed: { type: "boolean" description: "False if rate is a percentage and true if rate is monetary" } id: { type: "integer" format: "int32" description: "Unique identifier of the Order Product Tax" } name: { type: "string" description: "Name of the category that the tax is associated with or the tax name" } rate: { type: "number" format: "float" description: "Tax rate" } tax_on_product_price: { type: "boolean" description: "False if tax is not included on product price" } } } } variant_id: { type: "integer" format: "int32" description: "Unique identifier of the original Product Variant" } weight: { type: "number" format: "float" description: "Weight of the Order Product" } } } } recovery_url: { type: "string" description: "Recovery Order URL for the given Order" } shipment_status: { type: "string" description: "Shipment Status for Order Fulfillment." enum: ["delivered", "requested", "in_transit", "failed", "pickup_available"] } shipping: { type: "number" format: "float" description: "Shipping value for the given Order" } shipping_address: { properties: { address: { type: "string" description: "Address of the Order's Shipping Address" } city: { type: "string" description: "City of the Order's Shipping Address" } country: { type: "string" description: "Country code of the Order's Shipping Address (ISO 3166-1 alpha-2)" } country_name: { type: "string" description: "Country name 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" } name: { type: "string" description: "Name of the Order's Shipping Address" } postal: { type: "string" description: "Postal code of the Order's Shipping Address" } region: { type: "string" description: "Region code of the Order's Shipping Address (Use the FIPS standard - http://www.geonames.org/countries/)" } street_number: { type: "number" description: "Street number of the Order's Shipping Address" } surname: { type: "string" description: "Surname of the Order's Shipping Address" } } } shipping_discount: { type: "number" format: "float" description: "Shipping Discount value for the given order" } shipping_method_id: { type: "integer" format: "int32" description: "Shipping method e.g. Royal Mail" } shipping_method_name: { type: "string" description: "Shipping method e.g. Royal Mail" } shipping_option: { type: "string" description: "Shipping option for this order." enum: ["delivery", "store_pickup", "no_shipping"] } shipping_required: { type: "boolean" description: "False if the order is digital." } shipping_tax: { type: "number" format: "float" description: "Shipping Tax value for the given order" } shipping_taxes: { type: "array" items: { type: "object" properties: { country: { type: "string" description: "Code of the associated country" } fixed: { type: "boolean" description: "False if rate is a percentage and true if rate is monetary" } id: { type: "integer" format: "int32" description: "Unique identifier of the Order Shipping Tax" } name: { type: "string" description: "Tax name" } rate: { type: "number" format: "float" description: "Tax rate" } region: { type: "string" description: "Code of the associated region" } tax_on_shipping_price: { type: "boolean" description: "False if shipping tax is not included on shipping price" } } } } source: { properties: { campaign: { type: "string" description: "The campaign that referred the customer to the 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" } medium: { type: "string" description: "The medium that referred the customer to the checkout" } referral_code: { type: "string" description: "The code that referred the customer to the checkout" } referral_source: { type: "string" description: "The source that referred the customer to the website" } referral_url: { type: "string" description: "The website that referred the customer to the checkout" } source_name: { type: "string" description: "Where the checkout originated" } user_agent: { type: "string" description: "User agent of the referred request to checkout" } } } status: { type: "string" description: "Status of the Order" enum: ["Abandoned", "Canceled", "Pending Payment", "Paid"] } subtotal: { type: "number" format: "float" description: "Subtotal value for the given Order. Excluding taxes, shipping and discounts" } tax: { type: "number" format: "float" description: "Tax value for the given order" } total: { type: "number" format: "float" description: "Total value for the given Order. Including taxes, shipping and discounts" } tracking_company: { type: "string" description: "Company Used for Order Fulfillment." } tracking_number: { type: "string" description: "Tracking Number for Order Fulfillment." } tracking_url: { type: "string" description: "Tracking URL for Order Fulfillment." } } } } } } }