Performs the Edit the Service Provider and Cost action for a shipment.
post
/custom-actions/editServiceProviderAndCost/shipments/{shipment id}
Request
Path Parameters
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
-
cost:
cost
cost
-
serviceProviderId: string
serviceProviderId
-
shipmentCosts: array
shipmentCosts
The shipment costs.
Nested Schema : pks
Type:
array
Object primary keys that supports one or more multi-part (compound) keys
Show Source
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : items
Type:
Show Source
object
-
accessorialCode: string
An accessorial code.
-
adjustmentReason: string
The adjustment reason.
-
costType: string
costType
-
isCostFixed: boolean
Indicates that the cost is fixed.
-
paymentMethodCode: string
The payment method code.
-
processAsFlowThrough: boolean
Process as flow through.
-
shipmentCost:
shipmentCost
The shipment cost.
Response
Supported Media Types
- application/json
200 Response
Default response.
Nested Schema : editServiceProviderAndCostResponse-allOf[1]
Type:
Show Source
object
-
items: array
items
Edits the service provider and cost action response for a shipment.
Nested Schema : items
Type:
array
Edits the service provider and cost action response for a shipment.
Show Source
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 : 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