Jump to

• Request
• Response

Withdraw open tender offers for a shipment

post

/custom-actions/withdrawOpenTender/shipments/{shipmentId}

Request

Path Parameters

• shipmentId(required): string
  Shipment GID

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request body for the Withdraw Open Tender action.

Show Source

• shipmentPks: array shipmentPks
  Shipment PKs for the bulk endpoint only. Not required when shipmentId is provided in the path.
• tenderType(required): string
  Allowed Values: [ "S", "B" ]

  Tender type indicator. Use "S" for Spot Bid or "B" for Broadcast.

{
    "description":"Request body for the Withdraw Open Tender action.",
    "type":"object",
    "properties":{
        "shipmentPks":{
            "description":"Shipment PKs for the bulk endpoint only. Not required when shipmentId is provided in the path.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "tenderType":{
            "description":"Tender type indicator. Use \"S\" for Spot Bid or \"B\" for Broadcast.",
            "type":"string",
            "enum":[
                "S",
                "B"
            ]
        }
    },
    "required":[
        "tenderType"
    ]
}

Nested Schema : shipmentPks

Type: array

Shipment PKs for the bulk endpoint only. Not required when shipmentId is provided in the path.

Show Source

• Array of: string

{
    "description":"Shipment PKs for the bulk endpoint only. Not required when shipmentId is provided in the path.",
    "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 : withdrawOpenTenderResponse

Type: object

Response payload containing tender results.

Show Source

• items: array items
  Collection of tender responses generated by the action.

{
    "description":"Response payload containing tender results.",
    "type":"object",
    "properties":{
        "items":{
            "description":"Collection of tender responses generated by the action.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/withdrawOpenTenderResultItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Collection of tender responses generated by the action.

Show Source

• Array of: object withdrawOpenTenderResultItem
  Tender response details for a processed shipment.

{
    "description":"Collection of tender responses generated by the action.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/withdrawOpenTenderResultItem"
    }
}

Nested Schema : withdrawOpenTenderResultItem

Type: object

Tender response details for a processed shipment.

Show Source

• domainName: string
  Domain name associated with the tender results.
• endTime: endTime
  Shipment end time.
• rateOffering: string
  Rate offering identifier.
• serviceProviderID: string
  Service provider ID associated with the tender.
• shipmentPk: string
  Shipment primary key.
• startTime: startTime
  Shipment start time.
• totalActualCost: totalActualCost
  Total actual cost for the shipment.
• totalWeightedCost: totalWeightedCost
  Total weighted cost for the shipment.

{
    "description":"Tender response details for a processed shipment.",
    "type":"object",
    "properties":{
        "shipmentPk":{
            "description":"Shipment primary key.",
            "type":"string"
        },
        "totalActualCost":{
            "description":"Total actual cost for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalWeightedCost":{
            "description":"Total weighted cost for the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "startTime":{
            "description":"Shipment start time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"Shipment end time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "serviceProviderID":{
            "description":"Service provider ID associated with the tender.",
            "type":"string"
        },
        "rateOffering":{
            "description":"Rate offering identifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Domain name associated with the tender results.",
            "type":"string"
        }
    }
}

Nested Schema : endTime

Shipment end time.

Match All

Shipment end time.

Show Source

• object dateTimeType

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

Nested Schema : startTime

Shipment start time.

Match All

Shipment start time.

Show Source

• object dateTimeType

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

Nested Schema : totalActualCost

Total actual cost for the shipment.

Match All

Total actual cost for the shipment.

Show Source

• object currencyType

{
    "description":"Total actual cost for the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalWeightedCost

Total weighted cost for the shipment.

Match All

Total weighted cost for the shipment.

Show Source

• object currencyType

{
    "description":"Total weighted cost for the shipment.",
    "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

Bad Request. The server could not process the request due to missing or invalid input.

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. Valid authentication credentials are required.

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

Forbidden. Access to the specified resource is denied.

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

Internal Server Error. The server encountered an unexpected condition.

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