Skip to main content

update_order

POST 
/update_order

The merchant sends a request to this endpoint to update any order order details. If increasing the order_total, a check will be done to see if the increase is within the limit the merchant has agreed upon. An update can only occur if order has been placed ('order_placed'). Once an order has been confirmed ('order_confirmed') no updates can be made to the order details. Have a look at the Status Flow for context of order statuses.

Request​

Body

required
    backd_order_id stringrequired

    Unique identifier for the order in Backd's system.

    merchant_order_id stringrequired

    Unique identifier for the order in the merchant's system.

    merchant_order_status string

    Status of the order in the merchant's system.

    order_total number

    Total order amount including all applicable fees.

    cart_amount number

    Total amount in the shopping cart excluding fees.

    tax_amount number

    The amount of tax charged for the order.

    shipping_amount number

    The amount of shipping charged for the order.

    discount_amount number

    The total discount amount applied to the order as positive number.

    shipping object

    Contains shipping details for the order.

    name object

    Name of the recipient.

    first string

    First name of the recipient.

    last string

    Last name of the recipient.

    address object

    Shipping address details.

    line1 string

    First address line.

    line2 string

    Second address line (optional).

    city string

    City of the recipient.

    state string

    State of the recipient.

    zipcode string

    Zip code of the recipient.

    country string

    Country of the recipient.

    phone_number string

    Phone number of the recipient.

    email string

    Email address of the recipient.

    billing object

    Contains billing details for the order.

    name object

    Name of the billing contact.

    first string

    First name of the billing contact.

    last string

    Last name of the billing contact.

    address object

    Billing address details.

    line1 string

    First address line.

    line2 string

    Second address line (optional).

    city string

    City of the billing contact.

    state string

    State of the billing contact.

    zipcode string

    Zip code of the billing contact.

    country string

    Country of the billing contact.

    phone_number string

    Phone number of the billing contact.

    email string

    Email address of the billing contact.

    items object[]

    List of items included in the order.

  • Array [
    • display_name string

    Display name of the item.

    sku string

    Stock Keeping Unit (SKU) of the item.

    unit_price number

    Unit price of the item.

    qty number

    Quantity of the item ordered.

    item_image_url string

    URL of the item's image (optional).

    item_url string

    URL of the item's page (optional).

  • ]

Responses​

Updated order details.

Schema
    data object

    Order data returned by post-order management endpoints.

    backd_order_id string
    create_date string
    order_total number
    cart_amount number
    tax_amount number
    shipping_amount number
    discount_amount number
    status string
    merchant_order_id string
    merchant_order_status string

    Not returned by cancel_order.

    shipping object

    Name, address, phone, and email for a shipping or billing contact.

    name objectrequired

    First and last name of a person.

    first stringrequired
    last stringrequired
    company_name stringrequired
    address objectrequired

    Postal address.

    line1 stringrequired
    line2 string

    Second address line (optional).

    city stringrequired
    state stringrequired
    zipcode stringrequired
    country stringrequired
    phone_number stringrequired
    email stringrequired
    billing object

    Name, address, phone, and email for a shipping or billing contact.

    name objectrequired

    First and last name of a person.

    first stringrequired
    last stringrequired
    company_name stringrequired
    address objectrequired

    Postal address.

    line1 stringrequired
    line2 string

    Second address line (optional).

    city stringrequired
    state stringrequired
    zipcode stringrequired
    country stringrequired
    phone_number stringrequired
    email stringrequired
    items object[]
  • Array [
    • display_name stringrequired
    sku stringrequired
    unit_price numberrequired
    qty numberrequired
    item_image_url string

    URL of the item's image (optional).

    item_url string

    URL of the item's page (optional).

  • ]
    • refunds object[]

    Present on find_order, refund POST, and refund DELETE responses.

  • Array [
    • amount number
    create_date string
    status string
    locked_at string
  • ]
    • message string
    status object
    type string
    code integer
    error boolean
Loading...