Update order

patch

https://api.duda.co/api/sites/multiscreen/{site_name}/ecommerce/orders/{order_id}

Updates the order with the given id. Accepts changes to status, customer email, line items, billing and shipping addresses, shipping instructions, metadata, and marketing consent flags.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

site_name

string

required

The site's unique name (its ID), returned when the site is created.

order_id

string

required

The order's ID.

Body Params

status

string | null

enum

Status of the order

Allowed:

string | null

Email of the customer associated to the order

items

array of objects | null

Items bought with the order

items

billing_address

object | null

Billing address of the customer

shipping_address

object | null

Shipping address of the customer if an item in the order required shipment

shipping_instructions

string | null

Special instructions left by the customer for the delivery

metadata

string | null

Merchant defined JSON data for the whole order

customer_accepts_email_marketing

boolean | null

Consent of the customer to receive marketing emails. Omit to leave unchanged, send null to record
that the consent was not asked.

customer_accepts_sms_marketing

boolean | null

Consent of the customer to receive marketing SMS. Omit to leave unchanged, send null to record
that the consent was not asked.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

422Unprocessable Content

429Too many requests. The rate limit was exceeded.