Jump to

• Request
• Response

Performs the Calculate Best Direct Cost buy action for one or more order releases

post

/custom-actions/calculateDirectCostBuy/orderReleases/

Request

Header Parameters

• Prefer: string
  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

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object actionRequest

{
    "allOf":[
        {
            "$ref":"#/components/schemas/actionRequest"
        }
    ]
}

Nested Schema : actionRequest

Type: object

Show Source

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

{
    "properties":{
        "responsiblePartyGid":{
            "description":"Describes the person or people that will be affected by the action.",
            "type":"string"
        },
        "statusCodeGid":{
            "description":"A code associated with the action to be performed.",
            "type":"string"
        },
        "reasonCodeGid":{
            "description":"A code describing the reason for the action.",
            "type":"string"
        },
        "pks":{
            "description":"Object primary keys that supports one or more multi-part (compound) keys",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : pks

Type: array

Object primary keys that supports one or more multi-part (compound) keys

Show Source

• Array of: array items

{
    "description":"Object primary keys that supports one or more multi-part (compound) keys",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success! A successful POST method returns a 200 status code.

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/calculateDirectCostBuyResultItem"
                    }
                }
            }
        }
    ]
}

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/calculateDirectCostBuyResultItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Calculates the direct cost buy response for an order release.

Show Source

• Array of: object calculateDirectCostBuyResultItem

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

Nested Schema : calculateDirectCostBuyResultItem

Type: object

Show Source

• bestDirectCostBuy: bestDirectCostBuy
  The best direct cost buy value.
• msg: string
  An order release message or exception message.
• orderReleasePk: string
  The primary key for the order release.
• rateOfferingXidBuy: string
  The rate offering XID buy.

{
    "properties":{
        "orderReleasePk":{
            "description":"The primary key for the order release.",
            "type":"string"
        },
        "msg":{
            "description":"An order release message or exception message.",
            "type":"string"
        },
        "bestDirectCostBuy":{
            "description":"The best direct cost buy value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "rateOfferingXidBuy":{
            "description":"The rate offering XID buy.",
            "type":"string"
        }
    }
}

Nested Schema : bestDirectCostBuy

The best direct cost buy value.

Match All

The best direct cost buy value.

Show Source

• object currencyType

{
    "description":"The best direct cost buy value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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