apI
  1. {id}
apI
  • Emole Developer FrontEnd APi EndPoints
    • Authintication
    • Api Flow Chart
    • Public Back In Stock Subscription
      • Subscribe to back in stock product
      • Get customer back in stock subscriptions
      • Opt out from back in stock subscriptions
      • Prepare back in stock subscription model
    • Public Blog
      • Get all blog posts
      • Get all blog post tags
      • Get all blog post months
      • Get blog post
      • Add comment to a blog post
    • Public Category
      • Get categories to be displayed on home page
      • Get main top menu
      • Get specific category
      • Get category products
      • Get all root categories
      • Get all sub categories of the specified category
    • Public Checkout
      • Get order summary
      • Get all billing addresses
      • Select billing address
      • Add a new billing address
      • Get all pickup points
      • Get all shipping addresses
      • Select shipping address
      • Add a new shipping address
      • Get all shipping methods
      • Select shipping method
      • Get all payment methods
      • Select payment method
      • Prepare payment info model
      • Validate the payment info
      • Prepare confirm order model
      • Confirm and pay the order
      • Get completed order info
    • Public Common
      • Get all states of specific country
      • Get all languages
      • Set working language
      • Get all currencies
      • Set working currency
      • Get all tax types
      • Set tax display type
      • Find entity
    • Public Customer
      • Impersonate a customer
      • Get guest token to continue as a guest
      • Prepare login model
      • Login
      • Logout
      • Refresh access token on expiration
      • Prepare password recovery model
      • Submit password recovery request
      • Prepare the customer registration model
      • Submit the customer register request
      • Check username availability
      • Prepare customer navigation model
      • Get the customer info
      • Update the customer info
      • Delete the external authentication record
      • Get customer addresses
      • Delete the customer address
      • Prepare the add new customer address model
      • Add a new customer address
      • Get specific customer address
      • Update the customer address
      • Get the customer downloadable products
      • Get user agreement
      • Prepare change password model
      • Submit the change password request
      • Get customer avatar
      • Upload customer avatar
      • Remove customer avatar
      • Prepare GDPR tools model
      • Export customer GDPR info
      • Delete request of GDPR info
      • Prepare check gift card balance model
      • Check gift card balance
    • Public Download
      • Download product sample
      • Download the downloadable product
      • Download the order license
      • Download the file upload file
      • Download the order note file
    • Public Forum
      • Get all forums
      • Get all active discussions
      • Get active discussions in small for forum's index page
      • Get specific forum group
      • Get specific forum
      • Watch/Unwatch forum
      • Get specific forum topic
      • Watch/Unwatch forum topic
      • Prepare the move topic model
      • Move topic to another forum
      • Delete topic
      • Prepare create topic model
      • Create a new forum topic
      • Prepare edit topic model
      • Update the forum topic
      • Delete the post
      • Prepare create post model
      • Create a new forum topic post
      • Prepare edit post model
      • Update the post
      • Vote the post
      • Get last/latest post
      • Search into forum
      • Get customer forum subscriptions
      • Delete customer forum subscriptions
      • Prepare customer profile model
    • Public General
      • Get Topic
        • Get the specific topic(page) by topic identifier
        • Get the specific topic(page) by system name
      • Ping to check the api server status
      • Get all locale string resources
      • Get all settings of current store
      • Get header links info
      • Get footer info
      • Get polls to be displayed on home page
      • Vote a poll
      • Get all topics
      • Authenticate the topic(page)
      • Get nivo slider images(plugin)
      • Prepare the contact us model
      • Submit the contact us request
      • Prepare the contact vendor model
      • Submit the contact vendor request
      • Prepare newsletter box model
      • Subscribe to the news letters
    • Public Manufacturer
      • Prepare the manufacturer model
      • Get all manufacturers
      • Get manufacturer products
    • Public News
      • Get news to be displayed on home page
      • Get all news of the current store
      • Get specific news item
      • Add a new news item comment
    • Public Order
      • Get customer orders
      • Cancel recurring payment
      • Retry last recurring payment
      • Get customer reward points
      • Get specific order details
      • Get order invoice in pdf format
      • Re-order
      • Retry payment (Only redirection payment method type supported by nopCommerce)
      • Get specific shipment details
    • Public Private Messages
      • Get specific private message
      • Get all inbox messages
      • Get all sent messages
      • Delete inbox messages (selected)
      • Mark messages as unread (selected)
      • Delete sent messages (selected)
      • Prepare send message model
      • Send private message
      • Delete a private message
    • Public Product
      • Get products to be displayed on home page
      • Get best selling products
      • Get a product details
      • Change and apply product attributes
      • Estimate shipping
      • Get product combinations
      • Get marked as new products
      • Get product reviews
      • Add a new product review
      • Set product review helpfulness
      • Get customer product reviews
      • Prepare product email a friend model
      • Email the product to a friend
      • Get popular product tags
      • Get products by tag
      • Get related products
      • Get cross sell products
      • Get also purchased products
    • Public Return Request
      • Get customer return requests
      • Prepare return request model
      • Submit a return request
      • Upload a return request file
    • Public Search
      • Get search term auto complete response
      • Prepare search model
      • Search products
    • Public Shopping Cart
      • Get selected checkout attributes
      • Change and apply checkout attributes
      • Upload product attribute file
      • Upload checkout attribute file
      • Get customer cart
      • Delete cart items
      • Update quantities of the cart items
      • Add product to the cart
      • Apply discount coupon
      • Apply gift card coupon
      • Prepare estimate shipping model
      • Estimate shipping
      • Select shipping option
      • Remove discount coupon
      • Remove gift card coupon
      • Get order totals
      • Start checkout (to validate cart and go on checkout page)
      • Get customer wish list
      • Add product to wish list
      • Delete wish list items
      • Update quantities of wish list items
      • Move wish list items to cart
      • Prepare email wish list model
      • Send wish list link on email
    • Public Vendor
      • Prepare vendor model
      • Get vendor products
      • Get all vendors
      • Prepare apply for vendor model
      • Submit apply for vendor request
      • Prepare vendor info model
      • Update vendor info
      • Remove vendor picture
  • Emole Developer BackEnd Api
    • categories
      • {id}
        • Get Category By Id
        • Update Category
        • Delete Category
      • Get Categories
      • Create Category
      • Get Categories Count
    • customers
      • {id}
        • Get Customer By Id
        • Update Customer
        • Delete Customer
      • {customer Id}
        • Set Billing Address
        • Set Shipping Address
      • Get Customers
      • Create Customer
      • Get Current Customer
      • Get Customers Count
      • Search Customers
    • languages
      • current
        • Get Current Language
        • Set Current Language
      • Get All Languages
    • manufacturers
      • {id}
        • Get Manufacturer By Id
        • Update Manufacturer
        • Delete Manufacturer
      • Get Manufacturers
      • Create Manufacturer
      • Get Manufacturers Count
    • news letter subscriptions
      • Get News Letter Subscriptions
      • Deactivate News Letter Subscription
    • orders
      • {order Id}
        • items
          • {order Item Id}
            • Get Order Item By Id For Order
            • Update Order Item
            • Delete Order Item By Id
          • Get Order Items
          • Create Order Item
          • Delete All Order Items For Order
          • Get Order Items Count
        • Get Pdf Invoice
      • {id}
        • Get Order By Id
          GET
        • Update Order
          PUT
        • Delete Order
          DELETE
      • Get Orders
        GET
      • Create Order
        POST
      • Get Orders Count
        GET
      • Get Orders By Customer Id
        GET
    • productattributes
      • {id}
        • Get Product Attribute By Id
        • Update Product Attribute
        • Delete Product Attribute
      • Get Product Attributes
      • Create Product Attribute
      • Get Product Attributes Count
    • product category mappings
      • {id}
        • Get Product Category Mapping By Id
        • Update Product Category Mapping
        • Delete Product Category Mapping
      • Get Product Category Mappings
      • Create Product Category Mapping
      • Get Product Category Mappings Count
    • product manufacturer mappings
      • {id}
        • Get Product Manufacturer Mapping By Id
        • Update Product Manufacturer Mapping
        • Delete Product Manufacturer Mapping
      • Get Product Manufacturer Mappings
      • Create Product Manufacturer Mapping
      • Get Product Manufacturer Mappings Count
    • products
      • {id}
        • Get Product By Id
        • Update Product
        • Delete Product
      • Get Products
      • Create Product
      • Get Products Count
    • productspecificationattributes
      • {id}
        • Get Product Specification Attribute By Id
        • Update Product Specification Attribute
        • Delete Product Specification Attribute
      • Get Product Specification Attributes
      • Create Product Specification Attribute
      • Get Product Specification Attributes Count
    • shopping cart items
      • {id}
        • Update Shopping Cart Item
        • Delete Shopping Cart Item
      • Get Shopping Cart Items
      • Create Shopping Cart Item
      • Delete Shopping Cart Items
      • Get Current Shopping Cart
      • Batch Create Shopping Cart Items
    • specificationattributes
      • {id}
        • Get Specification Attribute By Id
        • Update Specification Attribute
        • Delete Specification Attribute
      • Get Specification Attributes
      • Create Specification Attribute
      • Get Specification Attributes Count
    • topics
      • {id}
        • Get Topic By Id
        • Update Topic
        • Delete Topic
      • Get Topics
      • Create Topic
    • token
      • Request Token
      • Validate Token
    • Get Countries
      GET
    • Get All Customer Roles
      GET
    • Get Current Store
      GET
    • Get All Stores
      GET
  1. {id}

Update Order

PUT
https://test.e-mole.net/api/orders/{id}
Last modified:2025-02-03 20:25:16

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
string 
required
(Required)
Example:
dolor
Header Params
Content-Type
string 
required
Example:
application/json
Accept
string 
required
Example:
text/plain
Body Params application/json
ObjectPropertyNameValuePairs
object 
required
ind
object 
required
order
object 
required
billing_address
object 
required
store_id
integer 
required
pick_up_in_store
boolean 
required
payment_method_system_name
string 
required
customer_currency_code
string 
required
currency_rate
number 
required
customer_tax_display_type_id
integer 
required
vat_number
string 
required
order_subtotal_incl_tax
number 
required
order_subtotal_excl_tax
number 
required
order_sub_total_discount_incl_tax
number 
required
order_sub_total_discount_excl_tax
number 
required
order_shipping_incl_tax
number 
required
order_shipping_excl_tax
number 
required
payment_method_additional_fee_incl_tax
number 
required
payment_method_additional_fee_excl_tax
number 
required
tax_rates
string 
required
order_tax
number 
required
order_discount
number 
required
order_total
number 
required
refunded_amount
number 
required
reward_points_were_added
boolean 
required
checkout_attribute_description
string 
required
customer_language_id
integer 
required
affiliate_id
integer 
required
customer_ip
string 
required
authorization_transaction_id
string 
required
authorization_transaction_code
string 
required
authorization_transaction_result
string 
required
capture_transaction_id
string 
required
capture_transaction_result
string 
required
subscription_transaction_id
string 
required
paid_date_utc
string 
required
shipping_method
string 
required
shipping_rate_computation_method_system_name
string 
required
custom_values_xml
string 
required
deleted
boolean 
required
created_on_utc
string 
required
customer
object 
required
customer_id
integer 
required
shipping_address
object 
required
order_items
array [object {1}] 
required
order_status
string 
required
payment_status
string 
required
shipping_status
string 
required
customer_tax_display_type
string 
required
id
integer 
required
Example
{
  "ObjectPropertyNameValuePairs": {
    "ind": {}
  },
  "order": {
    "billing_address": {
      "first_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "last_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "email": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "company": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "country_id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "country": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "state_province_id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "city": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "address1": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "address2": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "zip_postal_code": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "phone_number": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "fax_number": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "customer_attributes": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "created_on_utc": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "province": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      }
    },
    "store_id": 94012573,
    "pick_up_in_store": true,
    "payment_method_system_name": "consectetur quis",
    "customer_currency_code": "occaecat in quis est",
    "currency_rate": -59566797.366114385,
    "customer_tax_display_type_id": 77057786,
    "vat_number": "nulla dolore in esse",
    "order_subtotal_incl_tax": -58131758.71444831,
    "order_subtotal_excl_tax": 40160126.79817501,
    "order_sub_total_discount_incl_tax": -13294842.475643083,
    "order_sub_total_discount_excl_tax": 6163735.668429598,
    "order_shipping_incl_tax": 56665702.35677165,
    "order_shipping_excl_tax": -12398083.848523453,
    "payment_method_additional_fee_incl_tax": -23430781.413434505,
    "payment_method_additional_fee_excl_tax": 50541773.59272835,
    "tax_rates": "eu anim",
    "order_tax": -95695851.5167237,
    "order_discount": 26675280.17059225,
    "order_total": -68007454.56426248,
    "refunded_amount": 58834012.532686085,
    "reward_points_were_added": false,
    "checkout_attribute_description": "minim fugiat",
    "customer_language_id": 26684130,
    "affiliate_id": -42042701,
    "customer_ip": "pariatur do minim",
    "authorization_transaction_id": "aliqua est",
    "authorization_transaction_code": "mollit magna aute",
    "authorization_transaction_result": "fugiat mollit amet consequat",
    "capture_transaction_id": "et quis",
    "capture_transaction_result": "qui in su",
    "subscription_transaction_id": "nul",
    "paid_date_utc": "1994-01-15T07:32:05.143Z",
    "shipping_method": "magna",
    "shipping_rate_computation_method_system_name": "magna in incididunt",
    "custom_values_xml": "exercitation ut Duis",
    "deleted": false,
    "created_on_utc": "1999-12-28T21:36:50.247Z",
    "customer": {
      "customer_guid": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "username": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "email": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "first_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "last_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "language_id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "date_of_birth": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "gender": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "admin_comment": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "is_tax_exempt": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "has_shopping_cart_items": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "active": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "deleted": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "is_system_account": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "system_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "last_ip_address": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "created_on_utc": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "last_login_date_utc": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "last_activity_date_utc": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "registered_in_store_id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "subscribed_to_newsletter": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "role_ids": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      }
    },
    "customer_id": 46659050,
    "shipping_address": {
      "first_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "last_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "email": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "company": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "country_id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "country": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "state_province_id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "city": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "address1": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "address2": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "zip_postal_code": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "phone_number": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "fax_number": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "customer_attributes": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "created_on_utc": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "province": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      }
    },
    "order_items": [
      {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      }
    ],
    "order_status": "<string>",
    "payment_status": "<string>",
    "shipping_status": "<string>",
    "customer_tax_display_type": "adipisicing occaecat pariatur nulla dolor",
    "id": -73850289
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://test.e-mole.net/api/orders/dolor' \
--header 'Accept: text/plain' \
--header 'Content-Type: application/json' \
--data-raw '{
  "ObjectPropertyNameValuePairs": {
    "ind": {}
  },
  "order": {
    "billing_address": {
      "first_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "last_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "email": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "company": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "country_id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "country": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "state_province_id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "city": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "address1": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "address2": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "zip_postal_code": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "phone_number": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "fax_number": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "customer_attributes": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "created_on_utc": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "province": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      }
    },
    "store_id": 94012573,
    "pick_up_in_store": true,
    "payment_method_system_name": "consectetur quis",
    "customer_currency_code": "occaecat in quis est",
    "currency_rate": -59566797.366114385,
    "customer_tax_display_type_id": 77057786,
    "vat_number": "nulla dolore in esse",
    "order_subtotal_incl_tax": -58131758.71444831,
    "order_subtotal_excl_tax": 40160126.79817501,
    "order_sub_total_discount_incl_tax": -13294842.475643083,
    "order_sub_total_discount_excl_tax": 6163735.668429598,
    "order_shipping_incl_tax": 56665702.35677165,
    "order_shipping_excl_tax": -12398083.848523453,
    "payment_method_additional_fee_incl_tax": -23430781.413434505,
    "payment_method_additional_fee_excl_tax": 50541773.59272835,
    "tax_rates": "eu anim",
    "order_tax": -95695851.5167237,
    "order_discount": 26675280.17059225,
    "order_total": -68007454.56426248,
    "refunded_amount": 58834012.532686085,
    "reward_points_were_added": false,
    "checkout_attribute_description": "minim fugiat",
    "customer_language_id": 26684130,
    "affiliate_id": -42042701,
    "customer_ip": "pariatur do minim",
    "authorization_transaction_id": "aliqua est",
    "authorization_transaction_code": "mollit magna aute",
    "authorization_transaction_result": "fugiat mollit amet consequat",
    "capture_transaction_id": "et quis",
    "capture_transaction_result": "qui in su",
    "subscription_transaction_id": "nul",
    "paid_date_utc": "1994-01-15T07:32:05.143Z",
    "shipping_method": "magna",
    "shipping_rate_computation_method_system_name": "magna in incididunt",
    "custom_values_xml": "exercitation ut Duis",
    "deleted": false,
    "created_on_utc": "1999-12-28T21:36:50.247Z",
    "customer": {
      "customer_guid": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "username": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "email": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "first_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "last_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "language_id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "date_of_birth": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "gender": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "admin_comment": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "is_tax_exempt": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "has_shopping_cart_items": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "active": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "deleted": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "is_system_account": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "system_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "last_ip_address": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "created_on_utc": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "last_login_date_utc": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "last_activity_date_utc": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "registered_in_store_id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "subscribed_to_newsletter": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "role_ids": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      }
    },
    "customer_id": 46659050,
    "shipping_address": {
      "first_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "last_name": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "email": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "company": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "country_id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "country": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "state_province_id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "city": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "address1": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "address2": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "zip_postal_code": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "phone_number": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "fax_number": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "customer_attributes": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "created_on_utc": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "province": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "id": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      }
    },
    "order_items": [
      {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      }
    ],
    "order_status": "<string>",
    "payment_status": "<string>",
    "shipping_status": "<string>",
    "customer_tax_display_type": "adipisicing occaecat pariatur nulla dolor",
    "id": -73850289
  }
}'

Responses

🟢200Success
application/json
Body
orders
array [object {47}] 
required
billing_address
object 
required
store_id
integer 
required
pick_up_in_store
boolean 
required
payment_method_system_name
string 
required
customer_currency_code
string 
required
currency_rate
number 
required
customer_tax_display_type_id
integer 
required
vat_number
string 
required
order_subtotal_incl_tax
number 
required
order_subtotal_excl_tax
number 
required
order_sub_total_discount_incl_tax
number 
required
order_sub_total_discount_excl_tax
number 
required
order_shipping_incl_tax
number 
required
order_shipping_excl_tax
number 
required
payment_method_additional_fee_incl_tax
number 
required
payment_method_additional_fee_excl_tax
number 
required
tax_rates
string 
required
order_tax
number 
required
order_discount
number 
required
order_total
number 
required
refunded_amount
number 
required
reward_points_were_added
boolean 
required
checkout_attribute_description
string 
required
customer_language_id
integer 
required
affiliate_id
integer 
required
customer_ip
string 
required
authorization_transaction_id
string 
required
authorization_transaction_code
string 
required
authorization_transaction_result
string 
required
capture_transaction_id
string 
required
capture_transaction_result
string 
required
subscription_transaction_id
string 
required
paid_date_utc
string 
required
shipping_method
string 
required
shipping_rate_computation_method_system_name
string 
required
custom_values_xml
string 
required
deleted
boolean 
required
created_on_utc
string 
required
customer
object 
required
customer_id
integer 
required
shipping_address
object 
required
order_items
array [object {1}] 
required
order_status
object 
required
payment_status
object 
required
shipping_status
object 
required
customer_tax_display_type
string 
required
id
integer 
required
Example
{
  "orders": [
    {
      "billing_address": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "store_id": -31371905,
      "pick_up_in_store": false,
      "payment_method_system_name": "sed officia ut cillum Duis",
      "customer_currency_code": "commodo in dolore ex deserunt",
      "currency_rate": -42037360.23525422,
      "customer_tax_display_type_id": 1366408,
      "vat_number": "irure ipsum",
      "order_subtotal_incl_tax": 30382158.03811331,
      "order_subtotal_excl_tax": -52649404.62758383,
      "order_sub_total_discount_incl_tax": 69243000.80968511,
      "order_sub_total_discount_excl_tax": 64353371.679465264,
      "order_shipping_incl_tax": -35805123.061747946,
      "order_shipping_excl_tax": -3797082.2304397076,
      "payment_method_additional_fee_incl_tax": 65293156.897597104,
      "payment_method_additional_fee_excl_tax": 45227593.555425465,
      "tax_rates": "",
      "order_tax": 51923754.580895394,
      "order_discount": 98790784.31033856,
      "order_total": 45098807.99546412,
      "refunded_amount": -92948399.88753302,
      "reward_points_were_added": false,
      "checkout_attribute_description": "tempor adipisicing labore et",
      "customer_language_id": -97035484,
      "affiliate_id": 46614877,
      "customer_ip": "cillum et nisi ut in",
      "authorization_transaction_id": "veniam exercitation pariatur ut",
      "authorization_transaction_code": "Ut sunt culpa Excepteur officia",
      "authorization_transaction_result": "minim",
      "capture_transaction_id": "ullamco",
      "capture_transaction_result": "cupidatat Lorem quis Excepteur",
      "subscription_transaction_id": "ad sint quis",
      "paid_date_utc": "1977-08-05T07:54:36.111Z",
      "shipping_method": "tempor elit et enim",
      "shipping_rate_computation_method_system_name": "a",
      "custom_values_xml": "anim aute officia veniam",
      "deleted": false,
      "created_on_utc": "2013-03-13T09:55:05.210Z",
      "customer": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "customer_id": 50322454,
      "shipping_address": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "order_items": [
        {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      ],
      "order_status": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "payment_status": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "shipping_status": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "customer_tax_display_type": "nisi ullamco",
      "id": 33471094
    },
    {
      "billing_address": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "store_id": -54060630,
      "pick_up_in_store": false,
      "payment_method_system_name": "sunt nulla veniam",
      "customer_currency_code": "eiusm",
      "currency_rate": 18091503.5611621,
      "customer_tax_display_type_id": -32125508,
      "vat_number": "quis commodo ex voluptate",
      "order_subtotal_incl_tax": -26114804.67878793,
      "order_subtotal_excl_tax": -28526901.52583617,
      "order_sub_total_discount_incl_tax": -28120725.8426515,
      "order_sub_total_discount_excl_tax": 99801189.6852574,
      "order_shipping_incl_tax": -18318696.11485946,
      "order_shipping_excl_tax": 80228328.48099512,
      "payment_method_additional_fee_incl_tax": 79725541.90501183,
      "payment_method_additional_fee_excl_tax": 89595129.95889992,
      "tax_rates": "ut veniam Excepteur cupidatat",
      "order_tax": 41154358.04386735,
      "order_discount": -49979680.33715199,
      "order_total": 7714010.056065485,
      "refunded_amount": 45054019.550542146,
      "reward_points_were_added": false,
      "checkout_attribute_description": "mollit Excepteur non",
      "customer_language_id": -11830721,
      "affiliate_id": 10154969,
      "customer_ip": "aute",
      "authorization_transaction_id": "veniam sed",
      "authorization_transaction_code": "enim consequat",
      "authorization_transaction_result": "sit ut",
      "capture_transaction_id": "cupidatat occaecat velit sed elit",
      "capture_transaction_result": "aute Duis",
      "subscription_transaction_id": "laborum nisi",
      "paid_date_utc": "1947-09-30T02:08:55.365Z",
      "shipping_method": "ullamco est aliquip veniam",
      "shipping_rate_computation_method_system_name": "ullamco enim",
      "custom_values_xml": "non consectetur dolore dolore",
      "deleted": false,
      "created_on_utc": "1988-03-13T04:43:53.663Z",
      "customer": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "customer_id": -33440768,
      "shipping_address": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "order_items": [
        {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      ],
      "order_status": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "payment_status": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "shipping_status": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "customer_tax_display_type": "occaecat ipsum Duis",
      "id": 67206457
    }
  ]
}
🟠400Bad Request
🟠401Unauthorized
🟠404Not Found
🟠422Client Error
Modified at 2025-02-03 20:25:16
Previous
Get Order By Id
Next
Delete Order