Skip to content
Veeqo, An Amazon company Developers
Login Signup

Update Order Detail

PUT
/orders/{order_id}

Parameters

Path Parameters

order_id
required
integer

ID of the Order

Header Parameters

x-api-key
string

E.g. 123

Example
123

Request Body

object
order
object
channel_id

Store ID - See Stores Resource

number
3525
deliver_to_id

Optional if deliver_to_attributes are included.

Customer’s Shipping Address ID - See Customers Resource

number
1086864
delivery_method_id

Delivery Method ID - See Delivery Methods Resource

number
92298
due_date

Expected delivery date, appears in the order interface

string
02/03/2017
total_discounts

Total discounts price for the overall order

number
deliver_to_attributes

Delivery Address Attributes. Optional if deliver_to_id is included.

object
address1

Address line 1

string
294 Queenstown Road
address2

Address line 2

string
Borough
city

City

string
London
company

Company

string
Fashion Co
country

Country (ISO-2 code)

string
GB
customer_id
required

Customer’s ID - See Customers Resource

number
516208
first_name

First name

string
Sky
last_name

Last name

string
Schonhuber
phone

Phone number

string
07734450718
state

State

string
London
zip

ZIP code

string
S8 4LT
line_items_attributes

Line item attributes for the line items of the order

Array
payment_attributes

Payment attributes, if the order has a payment

object
payment_type
required

Type of payment - required if payment_attributes are included.

List of accepted payment types (variable_name: Display Name)

  • none: “None”

  • cash: “Cash”

  • credit_card: “Credit Card”

  • bank_transfer: “Bank Transfer”

  • paypal: “Paypal”

  • paypal_express: “Paypal Express”

  • sagepay: “Sagepay”

  • checkmo: “Check/Money order”

  • online_finance: “Online Finance”

string
cash
reference_number

A reference string to refer to that payment

string
123456789
customer_note_attributes

Notes from customer

object
text

Text for the note

string
Ring the doorbell the leave in secure location
employee_notes_attributes

Internal notes from employees

Array
Examples
{
  "order": {
    "line_items_attributes": [
      {
        "sellable_id": 11022902,
        "quantity": 1,
        "additional_options": "www.veeqo.com"
      }
    ]
  }
}

Responses

200

OK