Object Index / Definition

You are viewing an old version of the API
OrderFulfillmentRecipient

Contains information on the recipient of a fulfillment.

Properties

Name Description
customer_id
string

The Customer 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 will 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 will result in an error.

display_name
string

The display name of the fulfillment recipient.

If provided, overrides the value pulled from the customer profile indicated by customer_id.

Max Length 255
email_address
string

The email address of the fulfillment recipient.

If provided, overrides the value pulled from the customer profile indicated by customer_id.

Max Length 255
phone_number
string

The phone number of the fulfillment recipient.

If provided, overrides the value pulled from the customer profile indicated by customer_id.

Max Length 16
address
Address

Beta

The address of the fulfillment recipient.

If provided, overrides the value pulled from the customer profile indicated by customer_id.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?