Add a shipment to one or more shipment groups
post
/custom-actions/addToGroup/shipments/{shipment id}
Request
Header Parameters
-
Prefer:
An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.
Supported Media Types
- application/json
Nested Schema : actionRequest
Type:
Show Source
object
-
pks: array
pks
Object primary keys that supports one or more multi-part (compound) keys
-
reasonCodeGid: string
A code describing the reason for the action.
-
responsiblePartyGid: string
Describes the person or people that will be affected by the action.
-
statusCodeGid: string
A code associated with the action to be performed.
Nested Schema : type
Type:
Show Source
object
-
shipGroupPks(required): array
shipGroupPks
The type of the shipment group to find or create.
Nested Schema : pks
Type:
array
Object primary keys that supports one or more multi-part (compound) keys
Show Source
Nested Schema : shipGroupPks
Type:
array
The type of the shipment group to find or create.
Show Source
Response
Supported Media Types
- application/json
Default Response
Default Response.
Nested Schema : addToGroupResponse-allOf[1]
Type:
Show Source
object
-
failed: array
failed
The type of the shipment group to find or create.
-
passed: array
passed
The type of the shipment group to find or create.
Nested Schema : resultItem
Type:
Show Source
object
-
endTime:
endTime
The end time.
-
equipmentGroup: string
The equipment group.
-
rateOffering: string
The rate offering.
-
serviceProviderID: string
The service provider ID.
-
shipmentPk: string
The primary key for the shipment.
-
startTime:
startTime
The start time.
-
totalActualCost:
totalActualCost
The total actual cost.
-
totalWeightedCost:
totalWeightedCost
The total weighted cost.
-
transportMode: string
The transport mode.
Nested Schema : resultItemWithError-allOf[1]
Type:
Show Source
object
-
error: string
Error trying to add shipment to the target group.
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency