Jump to

• Request
• Response

Get open tender service provider options for one or more shipments

post

/custom-actions/getOpenTenderServiceProviderOptions/shipments

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request body for fetching open tender service provider options. Required for the bulk endpoint and optional for the single-shipment endpoint.

Show Source

• savedConditionGid: string
  Optional saved condition GID to expand the service provider list.
• savedQueryGid: string
  Optional saved query GID to expand the service provider list.
• shipmentPks: array shipmentPks
  Shipment PKs for the bulk endpoint only. Not required when shipmentId is provided in the path.
• tenderType: string
  Default Value: S

  Allowed Values: [ "S", "B" ]

  Tender type to evaluate. Use "S" for Spot Bid (default) or "B" for Broadcast.

{
    "description":"Request body for fetching open tender service provider options. Required for the bulk endpoint and optional for the single-shipment endpoint.",
    "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"
            }
        },
        "savedQueryGid":{
            "description":"Optional saved query GID to expand the service provider list.",
            "type":"string"
        },
        "savedConditionGid":{
            "description":"Optional saved condition GID to expand the service provider list.",
            "type":"string"
        },
        "tenderType":{
            "description":"Tender type to evaluate. Use \"S\" for Spot Bid (default) or \"B\" for Broadcast.",
            "type":"string",
            "enum":[
                "S",
                "B"
            ],
            "default":"S"
        }
    }
}

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

OK. Open tender service provider options returned.

Body ()

Root Schema : getOpenTenderServiceProviderOptionsResponse

Type: object

Response containing grouped open tender service provider options.

Show Source

• isSpotBid: boolean
  Indicates whether the tender is a spot bid.
• items: object getOpenTenderServiceProviderOptionsItems
  Grouped service provider lists returned by the Open Tender action.

{
    "description":"Response containing grouped open tender service provider options.",
    "type":"object",
    "properties":{
        "isSpotBid":{
            "description":"Indicates whether the tender is a spot bid.",
            "type":"boolean"
        },
        "items":{
            "description":"Grouped service provider lists organized by feasibility and source.",
            "$ref":"#/components/schemas/getOpenTenderServiceProviderOptionsItems"
        }
    }
}

Nested Schema : getOpenTenderServiceProviderOptionsItems

Type: object

Grouped service provider lists returned by the Open Tender action.

Show Source

• infeasibleLaneServiceProviders: array infeasibleLaneServiceProviders
  Lane service providers that are not feasible.
• infeasibleOtherServiceProviders: array infeasibleOtherServiceProviders
  Additional service providers that are not feasible.
• laneServiceProviders: array laneServiceProviders
  Service providers that are feasible for the lane.
• otherServiceProviders: array otherServiceProviders
  Additional service providers returned from saved query or condition criteria.

{
    "description":"Grouped service provider lists returned by the Open Tender action.",
    "type":"object",
    "properties":{
        "laneServiceProviders":{
            "description":"Service providers that are feasible for the lane.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/openTenderServiceProviderOption"
            }
        },
        "otherServiceProviders":{
            "description":"Additional service providers returned from saved query or condition criteria.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/openTenderServiceProviderOption"
            }
        },
        "infeasibleLaneServiceProviders":{
            "description":"Lane service providers that are not feasible.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/openTenderServiceProviderOption"
            }
        },
        "infeasibleOtherServiceProviders":{
            "description":"Additional service providers that are not feasible.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/openTenderServiceProviderOption"
            }
        }
    }
}

Nested Schema : infeasibleLaneServiceProviders

Type: array

Lane service providers that are not feasible.

Show Source

• Array of: object openTenderServiceProviderOption
  Service provider returned by the Open Tender action.

{
    "description":"Lane service providers that are not feasible.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/openTenderServiceProviderOption"
    }
}

Nested Schema : infeasibleOtherServiceProviders

Type: array

Additional service providers that are not feasible.

Show Source

• Array of: object openTenderServiceProviderOption
  Service provider returned by the Open Tender action.

{
    "description":"Additional service providers that are not feasible.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/openTenderServiceProviderOption"
    }
}

Nested Schema : laneServiceProviders

Type: array

Service providers that are feasible for the lane.

Show Source

• Array of: object openTenderServiceProviderOption
  Service provider returned by the Open Tender action.

{
    "description":"Service providers that are feasible for the lane.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/openTenderServiceProviderOption"
    }
}

Nested Schema : otherServiceProviders

Type: array

Additional service providers returned from saved query or condition criteria.

Show Source

• Array of: object openTenderServiceProviderOption
  Service provider returned by the Open Tender action.

{
    "description":"Additional service providers returned from saved query or condition criteria.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/openTenderServiceProviderOption"
    }
}

Nested Schema : openTenderServiceProviderOption

Type: object

Service provider returned by the Open Tender action.

Show Source

• infeasibilityReason: string
  Reason the service provider is infeasible, if applicable.
• isDigitalFreight: boolean
  Indicates whether the service provider is a digital freight provider.
• serviceProviderGid: string
  Service provider GID.
• serviceProviderName: string
  Service provider name.

{
    "description":"Service provider returned by the Open Tender action.",
    "type":"object",
    "properties":{
        "serviceProviderGid":{
            "description":"Service provider GID.",
            "type":"string"
        },
        "serviceProviderName":{
            "description":"Service provider name.",
            "type":"string"
        },
        "infeasibilityReason":{
            "description":"Reason the service provider is infeasible, if applicable.",
            "type":"string"
        },
        "isDigitalFreight":{
            "description":"Indicates whether the service provider is a digital freight provider.",
            "type":"boolean"
        }
    }
}

400 Response

Bad Request. The server could not understand the request due to invalid syntax or parameters.

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. Authentication is required and has failed or has not yet been provided.

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

Internal Server Error. The server encountered an internal error that prevented it from fulfilling this 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