--- title: "Modify an existing Order." method: PUT path: "/orders/{id}.json" tags: ["Orders"] --- # Modify an existing Order. `PUT /orders/{id}.json` Only `status`, `shipment_status`, `tracking_number`, `tracking_company`, `tracking_url`, `additional_information` and `additional_fields` are available for update. An email is send if `shipment_status` changes. ## Path parameters - `id` integer, required ## Request body - OrderEdit - `order` OrderEditFields - `status` 'Abandoned' | 'Canceled' | 'Pending Payment' | 'Paid' — Status of the Order - `shipment_status` 'requested' | 'in_transit' | 'delivered' | 'failed' | 'pickup_available' — Status of the Order Shipping - `tracking_number` string — Shipping Tracking Number used for the given Order - `tracking_company` string — Shipping Company used for the given Order - `tracking_url` string — URL to check delivery information for the given Order - `additional_information` string — Additional information for the given Order - `additional_fields` OrderAdditionalFields[] — Array of additional fields for the given Order - `label` string, string — Label of the additional field - `value` string, string — Value of the additional field - `id` integer — Id of the additional field - `area` string, string — Area of the additional field ## Response `200` OK - Order - `order` OrderFields - `id` integer — Unique identifier of the Order - `source` TrafficSource - `created_from` string — From where the order was created: [checkout, api, admin, duplicate, recovery, pos] - `created_from_app_code` string — The code of the app that created the order if it was created by an app through the API - `source_name` string — Where the checkout originated - `medium` string — The medium that referred the customer to the checkout - `campaign` string — The campaign that referred the customer to the checkout - `referral_url` string — The website that referred the customer to the checkout - `referral_code` string — The code that referred the customer to the checkout - `user_agent` string — User agent of the referred request to checkout - `first_page_visited` string — The first url visited by the customer - `first_page_visited_at` string — The date when the customer visited the first page - `referral_source` string — The source that referred the customer to the website - `created_at` string — Order date - `completed_at` string — The date when the order was first completed. - `currency` string — Currency of the Order - `subtotal` number, float — Subtotal value for the given Order. Excluding taxes, shipping and discounts - `tax` number, float — Tax value for the given order - `shipping_tax` number, float — Shipping Tax value for the given order - `shipping` number, float — Shipping value for the given Order - `shipping_required` boolean — False if the order is digital. - `total` number, float — Total value for the given Order. Including taxes, shipping and discounts - `discount` number, float — Discount value for the given Order - `shipping_discount` number, float — Shipping Discount value for the given order - `gift_cards_discount` number, float — Gift Cards Discount value for the given order - `fulfillment_status` string — Fulfillment Status for Order (translated). - `shipping_method_id` integer — Shipping method e.g. Royal Mail - `shipping_service_id` integer — Shipping service - `shipping_method_name` string — Shipping method e.g. Royal Mail - `payment_method_name` string — Payment Method name used e.g. PayPal - `payment_method_type` string — Payment Method type used e.g. paypal - `payment_information` string — Payment information for the given Order - `payment_notification_id` string — Payment notification identifier - `additional_information` string — Additional information for the given Order - `duplicate_url` string — Duplicate Order URL for the given Order - `recovery_url` string — Recovery Order URL for the given Order - `review_url` string — Review Order URL for the given Order - `checkout_url` string — Store Checkout Order URL for the given Order - `coupons` string — Promotion Coupons used on the given Order - `promotions` unknown[] — Promotions used on the given Order - unknown - `customer` CustomerSimpleFields - `id` integer — Unique identifier of the Customer - `email` string — Email of the Customer - `phone` string — Phone of the Customer - `phone_prefix` string — Phone prefix of the Customer - `ip` string — IP of the Customer - `fullname` string — Customer fullname retrieved from the default billing address. Defaults to customer email if no name is found. - `shipping_branch` OrderShippingBranch - `id` integer — ID of the Order's Shipping Branch - `name` string — Name of the Order's Shipping Branch - `shipping_address` OrderShippingAddress - `name` string — Name of the Order's Shipping Address - `surname` string — Surname of the Order's Shipping Address - `address` string — Address of the Order's Shipping Address - `city` string — City of the Order's Shipping Address - `postal` string — Postal code of the Order's Shipping Address - `region` string — Region name of the Order's Shipping Address - `country` string — Country name of the Order's Shipping Address - `country_code` string — Country code of the Order's Shipping Address (ISO 3166-1 alpha-2) - `region_code` string — Region code of the Order's Shipping Address (Use the FIPS standard - http://www.geonames.org/countries/) - `street_number` number — Street number of the Order's Shipping Address - `complement` string — Complement of the Order's Shipping Address - `latitude` number — Latitude of the Order's Shipping Address - `longitude` number — Longitude of the Order's Shipping Address - `municipality` string — Municipality of the Order's Shipping Address - `neighbourhood` string — Third level of administrative subdivision of the Customer's Shipping Address used only for some countries (e.g. Mexico) - `billing_address` OrderBillingAddress - `name` string — Name of the Order's Billing Address - `surname` string — Surname of the Order's Billing Address - `taxid` string — TaxID of the Order's Billing Address - `address` string — Address of the Order's Billing Address - `city` string — City of the Order's Billing Address - `postal` string — Postal code of the Order's Billing Address - `region` string — Region name of the Order's Billing Address - `country` string — Country name of the Order's Billing Address - `country_code` string — Country code of the Order's Billing Address (ISO 3166-1 alpha-2) - `region_code` string — Region code of the Order's Billing Address (Use the FIPS standard - http://www.geonames.org/countries/) - `street_number` number — Street number of the Order's Billing Address - `complement` string — Complement of the Order's Billing Address - `municipality` string — Municipality of the Order's Billing Address - `neighbourhood` string — Third level of administrative subdivision of the Customer's Shipping Address used only for some countries (e.g. Mexico) - `pickup_address` OrderPickupAddress - `name` string — Name of the Order's Pickup Address - `surname` string — Surname of the Order's Pickup Address - `address` string — Address of the Order's Pickup Address - `city` string — City of the Order's Pickup Address - `postal` string — Postal code of the Order's Pickup Address - `region` string — Region name of the Order's Pickup Address - `country` string — Country name of the Order's Pickup Address - `country_code` string — Country code of the Order's Pickup Address (ISO 3166-1 alpha-2) - `region_code` string — Region code of the Order's Pickup Address (Use the FIPS standard - http://www.geonames.org/countries/) - `street_number` number — Street number of the Order's Pickup Address - `complement` string — Complement of the Order's Pickup Address - `municipality` string — Municipality of the Order's Pickup Address - `pickup_place_name` string — Name of the Pickup Place - `products` OrderProduct[] - `id` integer — Unique identifier of the original Product - `variant_id` integer — Unique identifier of the original Product Variant - `sku` string — Stock Keeping Unit of the Order Product - `name` string — Name of the Order Product - `image` string — Image URL of the Order Product - `qty` integer — Price of the Order Product - `price` number, float — Price of the Order Product - `discount` number, float — Discount of the Order Product - `weight` number, float — Weight of the Order Product - `taxes` OrderProductTax[] - `id` integer — Unique identifier of the Order Product Tax - `name` string — Name of the category that the tax is associated with or the tax name - `rate` number, float — Tax rate - `fixed` boolean — False if rate is a percentage and true if rate is monetary - `tax_on_product_price` boolean — False if tax is not included on product price - `stock_locations` OrderProductStockLocations[] - `location_id` integer — Unique identifier of the Order Product Location - `stock` integer — Quantity in stock for the product at the location - `additional_fields` OrderAdditionalFields[] — Array of additional fields for the given Order - `label` string, string — Label of the additional field - `value` string, string — Value of the additional field - `id` integer — Id of the additional field - `area` string, string — Area of the additional field - `shipping_taxes` OrderShippingTax[] - `id` integer — Unique identifier of the Order Shipping Tax - `name` string — Tax name - `country` string — Code of the associated country - `region` string — Code of the associated region - `rate` number, float — Tax rate - `fixed` boolean — False if rate is a percentage and true if rate is monetary - `tax_on_shipping_price` boolean — False if shipping tax is not included on shipping price - `status` 'Abandoned' | 'Canceled' | 'Pending Payment' | 'Paid' — Status of the Order (translated). - `status_name` 'Abandoned' | 'Canceled' | 'Pending Payment' | 'Paid' — Status of the Order (translated). - `status_enum` 'abandoned' | 'canceled' | 'pending_payment' | 'paid' — Status of the Order (enum). - `tracking_url` string — Tracking URL for Order Fulfillment. - `tracking_company` string — Company Used for Order Fulfillment. - `tracking_number` string — Tracking Number for Order Fulfillment. - `shipping_option` 'delivery' | 'store_pickup' | 'no_shipping' — Shipping option for this order. - `same_day_delivery` boolean — True if same day delivery was selected for the order, false otherwise. - `shipment_status` 'Delivered' | 'Requested' | 'In Transit' | 'Failed' | 'Pickup Available' | 'Unfulfilled' — Shipment Status for Order and Order Fulfillment (translated). - `shipment_status_enum` 'delivered' | 'requested' | 'in_transit' | 'failed' | 'pickup_available' | 'unfulfilled' — Shipment Status for Order and Order Fulfillment (enum). - `recovered_from` integer — Show id of the order that was recovered from this order - `external_shipping_rate_id` string — Rate id for selected External Shipping Method rate - `external_shipping_rate_description` string — Rate description for selected External Shipping Method rate - `billing_information` BillingInformationFields - `business_activity` string — Giro - `company_name` string — Razon Social - `taxpayer_type` string — Tipo de Contribuinte ## Other responses - `404` — Order Not Found. --- [API](https://skmtc.net/jumpseller/apis/jumpseller-api.md) · [All operations](https://skmtc.net/jumpseller/apis/jumpseller-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jumpseller/jumpseller-api/versions/7512c6ae3524/schema)