Add the delivery address to an unpaid order that has none (used by the order page)

post/v1/orders/{order_id}/address

Request

  • Base URL: https://pod.agentmade.dev
  • URL: https://pod.agentmade.dev/v1/orders/{order_id}/address
  • Auth: none declared

Path parameters

order_idstring required

Request body

namestring required

Full name of the recipient.

companystring
address1string required

Street and house number.

address2string

Apartment, floor, etc.

citystring required
state_codestring

State or province code. Required for US, CA and AU.

postal_codestring required
country_codestring required

ISO 3166-1 alpha-2 country code, e.g. CZ, DE, US.

emailstring email

Recipient email, for carrier delivery notices only. Never used for receipts. For a gift, leave it empty unless the recipient agrees.

phonestring

Response

Order

order_idstring required

A bearer key: whoever has it can read and cancel the order. Do not share it publicly.

status'AWAITING_PAYMENT' | 'PAID' | 'VALIDATING' | 'SUBMITTING' | 'SUBMITTED' | 'IN_PRODUCTION' | 'SHIPPED' | 'DELIVERED' | 'QUOTE_EXPIRED' | 'PAYMENT_FAILED' | 'REJECTED' | 'SUBMISSION_FAILED' | 'CANCELLED' | 'REFUND_PENDING' | 'REFUNDED' | 'DISPUTED' required
next_stepstring required

What the agent should do next, in plain language.

address_neededboolean required

True when purchase had no street address: the person enters it on the order page before paying.

status_reasonstring nullable required
quote_idstring required
order_urlstring required

The order page. The person sees the status there.

Changes

No recorded changes to this operation across all 1 revision of this API.