Jump to

• Request
• Response

Perform the Accept or Decline action for a tender

post

/custom-actions/acceptDecline/tenders/{collab id}

Request

Path Parameters

• collab id(required): string
  Tender Collaboration ID

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request parameters for the accept or decline action.

Show Source

• acceptanceCode(required): string
  Acceptance code A for Accept action and D for Decline action
• bidAmount: bidAmount
  Bid amount provided by the service provider when accepting the broadcast tender
• conditionalSpotBids: object conditionalSpotBids
  Optional conditional spot bids for the tender.
• declineReasonCode: string
  Reason for declining the tender
• isRetender: boolean
  Retender to the another service provider when declining the tender
• pks: array pks
  Pass the collab ID(s) pks to perform decline tender for one or more records when the collad ID is not passed in the URL.
• remarks: object remarks
  Remarks to be added when accepting single shipment group tender.
• servprovGid: string
  Service provider ID when accepting/declining the broadcast tender

{
    "description":"Request parameters for the accept or decline action.",
    "type":"object",
    "properties":{
        "acceptanceCode":{
            "description":"Acceptance code A for Accept action and D for Decline action",
            "type":"string"
        },
        "servprovGid":{
            "description":"Service provider ID when accepting/declining the broadcast tender",
            "type":"string"
        },
        "bidAmount":{
            "description":"Bid amount provided by the service provider when accepting the broadcast tender",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "pks":{
            "description":"Pass the collab ID(s) pks to perform decline tender for one or more records when the collad ID is not passed in the URL.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "isRetender":{
            "description":"Retender to the another service provider when declining the tender",
            "type":"boolean"
        },
        "declineReasonCode":{
            "description":"Reason for declining the tender",
            "type":"string"
        },
        "remarks":{
            "description":"Remarks to be added when accepting single shipment group tender.",
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "remarkQual":{
                                "type":"string",
                                "description":"Remark Qualifier GID"
                            },
                            "remarkText":{
                                "type":"string",
                                "description":"Remark Text"
                            }
                        },
                        "required":[
                            "remarkQual",
                            "remarkText"
                        ]
                    }
                }
            }
        },
        "conditionalSpotBids":{
            "description":"Submit bid options for spot bid tender",
            "$ref":"#/components/schemas/conditionalSpotBids"
        }
    },
    "required":[
        "acceptanceCode"
    ]
}

Nested Schema : bidAmount

Bid amount provided by the service provider when accepting the broadcast tender

Match All

Bid amount provided by the service provider when accepting the broadcast tender

Show Source

• object currencyType

{
    "description":"Bid amount provided by the service provider when accepting the broadcast tender",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : conditionalSpotBids

Type: object

Optional conditional spot bids for the tender.

Show Source

• items: array items

{
    "description":"Optional conditional spot bids for the tender.",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "bidAmount":{
                        "description":"Bid amount provided by the service provider",
                        "allOf":[
                            {
                                "$ref":"#/components/schemas/currencyType"
                            }
                        ]
                    },
                    "spotRateGid":{
                        "description":"Spot Rate Id",
                        "type":"string"
                    },
                    "pickupTime":{
                        "description":"The pickup date/time of the shipment in ISO format.",
                        "type":"string",
                        "format":"date-time"
                    },
                    "dropoffTime":{
                        "description":"The delivery date/time of the shipment in ISO format.",
                        "type":"string",
                        "format":"date-time"
                    },
                    "sourceLocationGid":{
                        "description":"The source location of the shipment.",
                        "type":"string"
                    },
                    "destLocationGid":{
                        "description":"The destination location of the shipment.",
                        "type":"string"
                    },
                    "transportModeGid":{
                        "description":"The transport mode of the shipment.",
                        "type":"string"
                    },
                    "transitTime":{
                        "description":"The transit time for the shipment.",
                        "type":"string"
                    },
                    "isDirect":{
                        "description":"Flag to indicate if the proposed flight is direct or not.",
                        "type":"boolean"
                    },
                    "flightInstanceId":{
                        "description":"Flight Instance ID",
                        "type":"integer"
                    },
                    "tag1":{
                        "description":"Stores information.",
                        "type":"string"
                    },
                    "tag2":{
                        "description":"Stores information.",
                        "type":"string"
                    },
                    "tag3":{
                        "description":"Stores information.",
                        "type":"string"
                    },
                    "bidComment":{
                        "description":"Stores the user comments for each bid.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : pks

Type: array

Pass the collab ID(s) pks to perform decline tender for one or more records when the collad ID is not passed in the URL.

Show Source

• Array of: string

{
    "description":"Pass the collab ID(s) pks to perform decline tender for one or more records when the collad ID is not passed in the URL.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : remarks

Type: object

Remarks to be added when accepting single shipment group tender.

Show Source

• items: array items

{
    "description":"Remarks to be added when accepting single shipment group tender.",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "remarkQual":{
                        "type":"string",
                        "description":"Remark Qualifier GID"
                    },
                    "remarkText":{
                        "type":"string",
                        "description":"Remark Text"
                    }
                },
                "required":[
                    "remarkQual",
                    "remarkText"
                ]
            }
        }
    }
}

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

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "bidAmount":{
                "description":"Bid amount provided by the service provider",
                "allOf":[
                    {
                        "$ref":"#/components/schemas/currencyType"
                    }
                ]
            },
            "spotRateGid":{
                "description":"Spot Rate Id",
                "type":"string"
            },
            "pickupTime":{
                "description":"The pickup date/time of the shipment in ISO format.",
                "type":"string",
                "format":"date-time"
            },
            "dropoffTime":{
                "description":"The delivery date/time of the shipment in ISO format.",
                "type":"string",
                "format":"date-time"
            },
            "sourceLocationGid":{
                "description":"The source location of the shipment.",
                "type":"string"
            },
            "destLocationGid":{
                "description":"The destination location of the shipment.",
                "type":"string"
            },
            "transportModeGid":{
                "description":"The transport mode of the shipment.",
                "type":"string"
            },
            "transitTime":{
                "description":"The transit time for the shipment.",
                "type":"string"
            },
            "isDirect":{
                "description":"Flag to indicate if the proposed flight is direct or not.",
                "type":"boolean"
            },
            "flightInstanceId":{
                "description":"Flight Instance ID",
                "type":"integer"
            },
            "tag1":{
                "description":"Stores information.",
                "type":"string"
            },
            "tag2":{
                "description":"Stores information.",
                "type":"string"
            },
            "tag3":{
                "description":"Stores information.",
                "type":"string"
            },
            "bidComment":{
                "description":"Stores the user comments for each bid.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• bidAmount: bidAmount
  Bid amount provided by the service provider
• bidComment: string
  Stores the user comments for each bid.
• destLocationGid: string
  The destination location of the shipment.
• dropoffTime: string (date-time)
  The delivery date/time of the shipment in ISO format.
• flightInstanceId: integer
  Flight Instance ID
• isDirect: boolean
  Flag to indicate if the proposed flight is direct or not.
• pickupTime: string (date-time)
  The pickup date/time of the shipment in ISO format.
• sourceLocationGid: string
  The source location of the shipment.
• spotRateGid: string
  Spot Rate Id
• tag1: string
  Stores information.
• tag2: string
  Stores information.
• tag3: string
  Stores information.
• transitTime: string
  The transit time for the shipment.
• transportModeGid: string
  The transport mode of the shipment.

{
    "type":"object",
    "properties":{
        "bidAmount":{
            "description":"Bid amount provided by the service provider",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "spotRateGid":{
            "description":"Spot Rate Id",
            "type":"string"
        },
        "pickupTime":{
            "description":"The pickup date/time of the shipment in ISO format.",
            "type":"string",
            "format":"date-time"
        },
        "dropoffTime":{
            "description":"The delivery date/time of the shipment in ISO format.",
            "type":"string",
            "format":"date-time"
        },
        "sourceLocationGid":{
            "description":"The source location of the shipment.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The destination location of the shipment.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"The transport mode of the shipment.",
            "type":"string"
        },
        "transitTime":{
            "description":"The transit time for the shipment.",
            "type":"string"
        },
        "isDirect":{
            "description":"Flag to indicate if the proposed flight is direct or not.",
            "type":"boolean"
        },
        "flightInstanceId":{
            "description":"Flight Instance ID",
            "type":"integer"
        },
        "tag1":{
            "description":"Stores information.",
            "type":"string"
        },
        "tag2":{
            "description":"Stores information.",
            "type":"string"
        },
        "tag3":{
            "description":"Stores information.",
            "type":"string"
        },
        "bidComment":{
            "description":"Stores the user comments for each bid.",
            "type":"string"
        }
    }
}

Nested Schema : bidAmount

Bid amount provided by the service provider

Match All

Bid amount provided by the service provider

Show Source

• object currencyType

{
    "description":"Bid amount provided by the service provider",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "remarkQual":{
                "type":"string",
                "description":"Remark Qualifier GID"
            },
            "remarkText":{
                "type":"string",
                "description":"Remark Text"
            }
        },
        "required":[
            "remarkQual",
            "remarkText"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• remarkQual(required): string
  Remark Qualifier GID
• remarkText(required): string
  Remark Text

{
    "type":"object",
    "properties":{
        "remarkQual":{
            "type":"string",
            "description":"Remark Qualifier GID"
        },
        "remarkText":{
            "type":"string",
            "description":"Remark Text"
        }
    },
    "required":[
        "remarkQual",
        "remarkText"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

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

Body ()

Root Schema : acceptDeclineResponse

Type: object

Response after accept or decline the tender.

Show Source

• items: array items
  Accepte or Decline response for tender.

{
    "description":"Response after accept or decline the tender.",
    "type":"object",
    "properties":{
        "items":{
            "description":"Accepte or Decline response for tender.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/acceptDeclineResultItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Accepte or Decline response for tender.

Show Source

• Array of: object acceptDeclineResultItem

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

Nested Schema : acceptDeclineResultItem

Type: object

Show Source

• domainName: string
  Domain Name
• 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"
        },
        "domainName":{
            "description":"Domain Name",
            "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