Jump to

• Request
• Response

Performs the Calculate Best Direct Cost buy action for an order release.

post

/custom-actions/calculateDirectCostBuy/orderReleases/{order release id}

Request

Path Parameters

• order release id(required): string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Default response.

Body ()

Root Schema : calculateDirectCostBuyResponse

Match All

Show Source

• object actionResponse
• object calculateDirectCostBuyResponse-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/actionResponse"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "description":"Calculates the direct cost buy response for an order release.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/resultItem"
                    }
                }
            }
        }
    ]
}

Nested Schema : actionResponse

Type: object

Show Source

• success: string
  Success or failure.

{
    "properties":{
        "success":{
            "description":"Success or failure.",
            "type":"string"
        }
    }
}

Nested Schema : calculateDirectCostBuyResponse-allOf[1]

Type: object

Show Source

• items: array items
  Calculates the direct cost buy response for an order release.

{
    "type":"object",
    "properties":{
        "items":{
            "description":"Calculates the direct cost buy response for an order release.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/resultItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Calculates the direct cost buy response for an order release.

Show Source

• Array of: object resultItem

{
    "description":"Calculates the direct cost buy response for an order release.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/resultItem"
    }
}

Nested Schema : resultItem

Type: object

Show Source

• 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.

{
    "properties":{
        "shipmentPk":{
            "description":"The primary key for the shipment.",
            "type":"string"
        },
        "totalActualCost":{
            "description":"The total actual cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalWeightedCost":{
            "description":"The total weighted cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "startTime":{
            "description":"The start time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"The end time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "serviceProviderID":{
            "description":"The service provider ID.",
            "type":"string"
        },
        "transportMode":{
            "description":"The transport mode.",
            "type":"string"
        },
        "rateOffering":{
            "description":"The rate offering.",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"The equipment group.",
            "type":"string"
        }
    }
}

Nested Schema : endTime

The end time.

Match All

Show Source

• object dateTimeType

{
    "description":"The end time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : startTime

The start time.

Match All

Show Source

• object dateTimeType

{
    "description":"The start time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : totalActualCost

The total actual cost.

Match All

Show Source

• object currencyType

{
    "description":"The total actual cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalWeightedCost

The total weighted cost.

Match All

Show Source

• object currencyType

{
    "description":"The total weighted cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Back to Top