<- Object

Object

All versions ->

OrderFulfillmentRecipient

Information about the fulfillment recipient.

Link to section

Properties

Link to section

customer_id

string

The ID of the customer associated with the fulfillment. If customer_id is provided, the fulfillment recipient's display_name, email_address, and phone_number are automatically populated from the targeted customer profile. If these fields are set in the request, the request values override the information from the customer profile. If the targeted customer profile does not contain the necessary information and these fields are left unset, the request results in an error.

Max Length
191
Link to section

display_name

string

The display name of the fulfillment recipient. This field is required. If provided, the display name overrides the corresponding customer profile value indicated by customer_id.

Max Length
255
Link to section

email_address

string

The email address of the fulfillment recipient. If provided, the email address overrides the corresponding customer profile value indicated by customer_id.

Max Length
255
Link to section

phone_number

string

The phone number of the fulfillment recipient. This field is required. If provided, the phone number overrides the corresponding customer profile value indicated by customer_id.

Max Length
17
Link to section

address

Beta

The address of the fulfillment recipient. This field is required. If provided, the address overrides the corresponding customer profile value indicated by customer_id.