API reference
A valid request URL is required to generate request examples{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"carrierId": "<string>",
"credentialSet": {
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"carrierId": "<string>",
"code": "<string>",
"integrationId": "<string>",
"name": "<string>",
"values": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"locationCode": "<string>",
"locationGroupCode": "<string>",
"siteId": 123
}Create Carrier Credentials
Creates new carrier credentials. See this guide for details about the fields that are required for each carrier.
A valid request URL is required to generate request examples{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"carrierId": "<string>",
"credentialSet": {
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"carrierId": "<string>",
"code": "<string>",
"integrationId": "<string>",
"name": "<string>",
"values": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"locationCode": "<string>",
"locationGroupCode": "<string>",
"siteId": 123
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
The carrier ID.
Query Parameters
limits which fields are returned in the response body
Body
The carrier credential data.
Stores a reference to a Mozu.ShippingAdmin.Contracts.Carriers.CarrierCredentialSet for use at different levels. Valid levels include Site, Location Group, and Location. Different levels may be used for rates versus labels. Site level is overriden by Location Group level which is overriden by Location level.
Show child attributes
Show child attributes
The Carrier ID associated with this carrier credential. Usually the short name of a carrier (e.g., "FedEx").
Stores a set of
Show child attributes
Show child attributes
The Location Code associated with this carrier credential, if any.
The Location Group Code associated with this carrier credential, if any.
The Site ID associated with this carrier credential, if any.
Response
Success
Stores a reference to a Mozu.ShippingAdmin.Contracts.Carriers.CarrierCredentialSet for use at different levels. Valid levels include Site, Location Group, and Location. Different levels may be used for rates versus labels. Site level is overriden by Location Group level which is overriden by Location level.
Show child attributes
Show child attributes
The Carrier ID associated with this carrier credential. Usually the short name of a carrier (e.g., "FedEx").
Stores a set of
Show child attributes
Show child attributes
The Location Code associated with this carrier credential, if any.
The Location Group Code associated with this carrier credential, if any.
The Site ID associated with this carrier credential, if any.