Jump to

• Request
• Response

Perform decline action for one or more Tenders

post

/custom-actions/decline/tenders/

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object actionRequest
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/actionRequest"
        },
        {
            "type":"object",
            "properties":{
                "isRetender":{
                    "description":"Is retender",
                    "type":"boolean"
                },
                "declineReasonCode":{
                    "description":"declineReasonCode",
                    "type":"string"
                }
            }
        }
    ]
}

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 : type

Type: object

Show Source

• declineReasonCode: string
  declineReasonCode
• isRetender: boolean
  Is retender

{
    "type":"object",
    "properties":{
        "isRetender":{
            "description":"Is retender",
            "type":"boolean"
        },
        "declineReasonCode":{
            "description":"declineReasonCode",
            "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 : declineResponse

Match All

Show Source

• object actionResponse
• object declineResponse-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/actionResponse"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "description":"Decline response for tender.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/declineResultItem"
                    }
                }
            }
        }
    ]
}

Nested Schema : actionResponse

Type: object

Show Source

• success: string
  Success or failure.

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

Nested Schema : declineResponse-allOf[1]

Type: object

Show Source

• items: array items
  Decline response for tender.

{
    "type":"object",
    "properties":{
        "items":{
            "description":"Decline response for tender.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/declineResultItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Decline response for tender.

Show Source

• Array of: object declineResultItem

{
    "description":"Decline response for tender.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/declineResultItem"
    }
}

Nested Schema : declineResultItem

Type: object

Show Source

• endTime: endTime
  End Time
• rateOffering: string
  Rate Offering
• serviceProviderID: string
  Service Provider ID
• shipmentPk: string
  Pk of the shipment
• startTime: startTime
  Start Time
• totalActualCost: totalActualCost
  Total Actual Cost
• totalWeightedCost: totalWeightedCost
  Total Weighted Cost

{
    "properties":{
        "shipmentPk":{
            "description":"Pk of the shipment",
            "type":"string"
        },
        "totalActualCost":{
            "description":"Total Actual Cost",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalWeightedCost":{
            "description":"Total Weighted Cost",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "startTime":{
            "description":"Start Time",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"End Time",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "serviceProviderID":{
            "description":"Service Provider ID",
            "type":"string"
        },
        "rateOffering":{
            "description":"Rate Offering",
            "type":"string"
        }
    }
}

Nested Schema : endTime

End Time

Match All

End Time

Show Source

• object dateTimeType

{
    "description":"End Time",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : startTime

Start Time

Match All

Start Time

Show Source

• object dateTimeType

{
    "description":"Start Time",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : totalActualCost

Total Actual Cost

Match All

Total Actual Cost

Show Source

• object currencyType

{
    "description":"Total Actual Cost",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalWeightedCost

Total Weighted Cost

Match All

Total Weighted Cost

Show Source

• object currencyType

{
    "description":"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"
        }
    }
}

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

401 Response

Unauthorized, the request was not successful because it lacks valid authentication credentials for the requested resource.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

403 Response

Access to the specified resource has been forbidden.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

Back to Top