Shipping Profile
Think of Shipping Profile as a preset on how to print shipping labels. Profile can define From address, return address, label and packing list options, and what carrier account to use.
GET Request
Query parameters
| Property | Type | Description | Constraints |
|---|---|---|---|
ProfileId |
integer | Filter by profile ID (exact match). Use to look up a specific shipping profile by its numeric ID. | |
Active |
boolean | Filter by active flag: true = active only, false = inactive only. Omit to return all profiles. | |
ProfileName |
string | Case-insensitive substring search on profile name. Returns all profiles whose name contains this string. |
GET Response - 200
Shipping Profile Get Response
| Property | Type | Description | Constraints |
|---|---|---|---|
Profiles |
ShippingProfile[] | Required |
ShippingProfile
Shipping profile (identity, address, return address)
| Property | Type | Description | Constraints |
|---|---|---|---|
ProfileId |
integer | ||
ProfileName |
string | ||
Address |
ReturnAddress | Return address printed on labels | |
ReturnAddress |
ReturnAddress | Return address printed on labels | |
OnlyBill3rdParty |
boolean | Only bill 3rd party | |
ForceProvider |
string | Force label provider: 'marketplace' or 'native'. Set to 'off' to clear (no forcing). | One of: marketplace, native, off |
Reference1 |
string | Reference 1 | |
Reference2 |
string | Reference 2 | |
Reference3 |
string | Reference 3 | |
Reference4 |
string | Reference 4 | |
Active |
boolean |
ReturnAddress
Return address printed on labels
| Property | Type | Description | Constraints |
|---|---|---|---|
Name |
string | Full name. Use instead of FirstName + LastName when the name split is unavailable. At least one of Name, FirstName + LastName, or Company is required. | Max-Length: 128 |
FirstName |
string | First name. Use together with LastName instead of Name when the name split is available. Cannot be combined with Name. | Max-Length: 128 |
LastName |
string | Last name. Use together with FirstName instead of Name when the name split is available. Cannot be combined with Name. | Max-Length: 128 |
Company |
string | Company or organization name. At least one of Name, FirstName + LastName, or Company is required. | Max-Length: 127 |
Street |
string | Street address, line 1 (building number and street name). | Max-Length: 255 |
Street2 |
string | Street address, line 2 (apartment, suite, unit, floor, etc.). | Max-Length: 255 |
City |
string | City or town name. | Max-Length: 40Min-Length: 1 |
State |
string | US state abbreviation (e.g. CA) or province/region name for international addresses. | Max-Length: 40 |
ZipCode |
string | US ZIP code or international postal code. | |
CountryCode |
string | ISO 3166-1 alpha-2 country code (e.g. US, CA, GB). | Max-Length: 2Min-Length: 2Pattern: [A-Z]{2} |
Country |
string | Full country name (e.g. United States, Canada). Defaults to United States | |
PhoneNumber |
string | Phone number. Format may be normalized by the carrier. | Max-Length: 40 |
Email |
string | Email address. |
GET Response - 400
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
GET Response - 401
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
GET Response - 500
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
POST Request
ShippingProfile
Shipping profile (identity, address, return address)
| Property | Type | Description | Constraints |
|---|---|---|---|
ProfileId |
integer | ||
ProfileName |
string | ||
Address |
ReturnAddress | Return address printed on labels | |
ReturnAddress |
ReturnAddress | Return address printed on labels | |
OnlyBill3rdParty |
boolean | Only bill 3rd party | |
ForceProvider |
string | Force label provider: 'marketplace' or 'native'. Set to 'off' to clear (no forcing). | One of: marketplace, native, off |
Reference1 |
string | Reference 1 | |
Reference2 |
string | Reference 2 | |
Reference3 |
string | Reference 3 | |
Reference4 |
string | Reference 4 | |
Active |
boolean |
ReturnAddress
Return address printed on labels
| Property | Type | Description | Constraints |
|---|---|---|---|
Name |
string | Full name. Use instead of FirstName + LastName when the name split is unavailable. At least one of Name, FirstName + LastName, or Company is required. | Max-Length: 128 |
FirstName |
string | First name. Use together with LastName instead of Name when the name split is available. Cannot be combined with Name. | Max-Length: 128 |
LastName |
string | Last name. Use together with FirstName instead of Name when the name split is available. Cannot be combined with Name. | Max-Length: 128 |
Company |
string | Company or organization name. At least one of Name, FirstName + LastName, or Company is required. | Max-Length: 127 |
Street |
string | Street address, line 1 (building number and street name). | Max-Length: 255 |
Street2 |
string | Street address, line 2 (apartment, suite, unit, floor, etc.). | Max-Length: 255 |
City |
string | City or town name. | Max-Length: 40Min-Length: 1 |
State |
string | US state abbreviation (e.g. CA) or province/region name for international addresses. | Max-Length: 40 |
ZipCode |
string | US ZIP code or international postal code. | |
CountryCode |
string | ISO 3166-1 alpha-2 country code (e.g. US, CA, GB). | Max-Length: 2Min-Length: 2Pattern: [A-Z]{2} |
Country |
string | Full country name (e.g. United States, Canada). Defaults to United States | |
PhoneNumber |
string | Phone number. Format may be normalized by the carrier. | Max-Length: 40 |
Email |
string | Email address. |
POST Response - 200
ShippingProfileOperationResult
| Property | Type | Description | Constraints |
|---|---|---|---|
ProfileId |
integer | ||
Status |
string | RequiredOne of: Success, Failure, NotFound | |
Message |
string |
POST Response - 400
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
POST Response - 401
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
POST Response - 500
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
PUT Request
ShippingProfile
Shipping profile (identity, address, return address)
| Property | Type | Description | Constraints |
|---|---|---|---|
ProfileId |
integer | ||
ProfileName |
string | ||
Address |
ReturnAddress | Return address printed on labels | |
ReturnAddress |
ReturnAddress | Return address printed on labels | |
OnlyBill3rdParty |
boolean | Only bill 3rd party | |
ForceProvider |
string | Force label provider: 'marketplace' or 'native'. Set to 'off' to clear (no forcing). | One of: marketplace, native, off |
Reference1 |
string | Reference 1 | |
Reference2 |
string | Reference 2 | |
Reference3 |
string | Reference 3 | |
Reference4 |
string | Reference 4 | |
Active |
boolean |
ReturnAddress
Return address printed on labels
| Property | Type | Description | Constraints |
|---|---|---|---|
Name |
string | Full name. Use instead of FirstName + LastName when the name split is unavailable. At least one of Name, FirstName + LastName, or Company is required. | Max-Length: 128 |
FirstName |
string | First name. Use together with LastName instead of Name when the name split is available. Cannot be combined with Name. | Max-Length: 128 |
LastName |
string | Last name. Use together with FirstName instead of Name when the name split is available. Cannot be combined with Name. | Max-Length: 128 |
Company |
string | Company or organization name. At least one of Name, FirstName + LastName, or Company is required. | Max-Length: 127 |
Street |
string | Street address, line 1 (building number and street name). | Max-Length: 255 |
Street2 |
string | Street address, line 2 (apartment, suite, unit, floor, etc.). | Max-Length: 255 |
City |
string | City or town name. | Max-Length: 40Min-Length: 1 |
State |
string | US state abbreviation (e.g. CA) or province/region name for international addresses. | Max-Length: 40 |
ZipCode |
string | US ZIP code or international postal code. | |
CountryCode |
string | ISO 3166-1 alpha-2 country code (e.g. US, CA, GB). | Max-Length: 2Min-Length: 2Pattern: [A-Z]{2} |
Country |
string | Full country name (e.g. United States, Canada). Defaults to United States | |
PhoneNumber |
string | Phone number. Format may be normalized by the carrier. | Max-Length: 40 |
Email |
string | Email address. |
PUT Response - 200
ShippingProfileOperationResult
| Property | Type | Description | Constraints |
|---|---|---|---|
ProfileId |
integer | ||
Status |
string | RequiredOne of: Success, Failure, NotFound | |
Message |
string |
PUT Response - 400
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
PUT Response - 401
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
PUT Response - 500
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
DELETE Request
Shipping Profile Delete
Used to delete a shipping profile. Provide either ProfileId or ProfileName.
| Property | Type | Description | Constraints |
|---|---|---|---|
ProfileId |
integer | ID of the profile to delete | |
ProfileName |
string | Name of the profile to delete (used if ProfileId is not provided) |
DELETE Response - 200
ShippingProfileOperationResult
| Property | Type | Description | Constraints |
|---|---|---|---|
ProfileId |
integer | ||
Status |
string | RequiredOne of: Success, Failure, NotFound | |
Message |
string |
DELETE Response - 400
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
DELETE Response - 401
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |
DELETE Response - 500
Message
| Property | Type | Description | Constraints |
|---|---|---|---|
Success |
boolean | Always false on this envelope. Message is the error envelope (4xx/5xx); Success is kept on the wire so legacy clients can branch on it without parsing the HTTP status. | Required |
Code |
integer | Indicate error code. Codes list and description are located on help page https://www.teapplix.com/help/?page_id=7115 | |
Message |
string | Message typically associated with errors | |
Description |
string[] | Detailed description |