Defines shipping address and delivery information fields used for Remote API transaction processing and confirmation outputs.
Shipping Address and Delivery Fields
Use the fields below to provide shipping and delivery information for Remote API transactions. These values may also be used in confirmation emails when enabled.
| Variable | Requirement | Type | Max Size | Possible Values / Example | Description | Notes |
|---|---|---|---|---|---|---|
shipinfo |
Optional | integer | 1 | 1, 0 |
Controls whether shipping information is displayed in confirmation emails. | 1 = show shipping info, 0 = hide shipping info (default). |
shipcompany |
Optional | string | 39 | Demo Company |
Company name associated with the shipping address. | Optional on all credit card transactions. |
shipname |
Optional | string | 39 | John A. Smith |
Name associated with the shipping address. | Used for delivery labeling. |
address1 |
Optional | string | 39 | 123 Main Street |
Shipping address line 1. | Primary street address. |
address2 |
Optional | string | 39 | Apt 4B |
Shipping address line 2. | Optional unit or suite information. |
city |
Optional | string | 39 | Townsville |
Shipping city. | Used for delivery routing. |
state |
Optional | string | 2 | NY |
Shipping state or province code. | Use standard 2-character state abbreviations when applicable. |
province |
Optional | string | 39 | Ontario |
International province or region name. | For non-US/Canada addresses, set state to ZZ and provide province here. |
zip |
Optional | string | 10 | 11779 |
Shipping ZIP or postal code. | Supports international postal formats. |
country |
Optional | string | 2 | US |
Shipping country code. | Use standard ISO 2-character country codes. |