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.

Request

application/json

Body

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 stringrequired

Status of the order in the merchant's system.

order_total numberrequired

Total order amount including all applicable fees.

cart_amount numberrequired

Total amount in the shopping cart excluding fees.

tax_amount numberrequired

The amount of tax charged for the order.

shipping_amount numberrequired

The amount of shipping charged for the order.

discount_amount numberrequired

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 stringrequired

First name of the recipient.

last stringrequired

Last name of the recipient.

address object

Shipping address details.

line1 stringrequired

First address line.

line2 stringrequired

Second address line (optional).

city stringrequired

City of the recipient.

state stringrequired

State of the recipient.

zipcode stringrequired

Zip code of the recipient.

country stringrequired

Country of the recipient.

phone_number stringrequired

Phone number of the recipient.

email stringrequired

Email address of the recipient.

billing object

Contains billing details for the order.

name object

Name of the billing contact.

first stringrequired

First name of the billing contact.

last stringrequired

Last name of the billing contact.

address object

Billing address details.

line1 stringrequired

First address line.

line2 stringrequired

Second address line (optional).

city stringrequired

City of the billing contact.

state stringrequired

State of the billing contact.

zipcode stringrequired

Zip code of the billing contact.

country stringrequired

Country of the billing contact.

phone_number stringrequired

Phone number of the billing contact.

email stringrequired

Email address of the billing contact.

items object[]
List of items included in the order.
Array [
display_name stringrequired
Display name of the item.
sku stringrequired
Stock Keeping Unit (SKU) of the item.
unit_price numberrequired
Unit price of the item.
qty integerrequired
Quantity of the item ordered.
item_image_url stringrequired
URL of the item's image (optional).
item_url stringrequired
URL of the item's page (optional).
]

Responses

200

Updated order details.

application/json

Schema

Schema

order_total numberrequired

Total order amount after updates.

cart_amount numberrequired

Total amount in the shopping cart.

tax_amount numberrequired

The amount of tax charged for the order.

shipping_amount numberrequired

The amount of shipping charged for the order.

discount_amount numberrequired

The total discount amount applied to the order.

status stringrequired

Status of the order in Backd's system.

merchant_order_id stringrequired

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

merchant_order_status stringrequired

Status of the order in the merchant's system.

shipping object
Updated shipping details.
name object
Name of the recipient.
first stringrequired
last stringrequired
address object
Shipping address details.
line1 stringrequired
line2 stringrequired
city stringrequired
state stringrequired
zipcode stringrequired
country stringrequired
phone_number stringrequired
email stringrequired
billing object
Updated billing details.
name object
Name of the recipient.
first stringrequired
last stringrequired
address object
Billing address details.
line1 stringrequired
line2 stringrequired
city stringrequired
state stringrequired
zipcode stringrequired
country stringrequired
phone_number stringrequired
email stringrequired
items object[]
Updated list of items included in the order.
Array [
display_name stringrequired
Display name of the item.
sku stringrequired
Stock Keeping Unit (SKU) of the item.
unit_price numberrequired
Unit price of the item.
qty integerrequired
Quantity of the item ordered.
item_image_url stringrequired
URL of the item's image (optional).
item_url stringrequired
URL of the item's page (optional).
]

Example (from schema)

{
  "order_total": 8950,
  "cart_amount": 9000,
  "tax_amount": 100,
  "shipping_amount": 50,
  "discount_amount": 200,
  "status": "order_placed",
  "merchant_order_id": "JKLMO4321",
  "merchant_order_status": "processing",
  "shipping": {
    "name": {
      "first": "Joe",
      "last": "Doe"
    },
    "address": {
      "line1": "123 Main St",
      "line2": "Floor 1",
      "city": "Austin",
      "state": "TX",
      "zipcode": "78704",
      "country": "USA"
    },
    "phone_number": "4153334567",
    "email": "joedoe@123fakestreet.com"
  },
  "billing": {
    "name": {
      "first": "Joe",
      "last": "Doe"
    },
    "address": {
      "line1": "123 Main St",
      "line2": "Floor 1",
      "city": "Austin",
      "state": "TX",
      "zipcode": "78704",
      "country": "USA"
    },
    "phone_number": "4153334567",
    "email": "joedoe@123fakestreet.com"
  },
  "items": [
    {
      "display_name": "MacBook Pro",
      "sku": "ABC-123",
      "unit_price": 3000,
      "qty": 3,
      "item_image_url": "http://merchant.website.com/images/macbook-pro.jpg",
      "item_url": "http://merchant.website.com/products/macbook-pro.html"
    }
  ]
}

Loading...