Add a shipment to a shipment group by group type.
post
/custom-actions/addToGroupByType/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
-
addToExistingGroup: string
Allowed Values:
[ "yes", "no" ]
Specify whether or not to create a new shipment group. Default is 'yes' -
shipGroupTypeGid(required): string
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
Response
Supported Media Types
- application/json
Default Response
Default Response.