Jump to

• Request
• Response

Get Tenders

get

/tenders

Request

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tenders"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object tenders

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tenders"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : tenders

Type: object

Show Source

• conditionalBookingFields: conditionalBookingFields
• deliveryTime: deliveryTime
  No description.
• destinationLocation: string
  A unique identifier to define the locations withing GC3. The gid contains the domain portion.
• domainName: string
  No description.
• expectedResponse: expectedResponse
  No description.
• expectedRespUpdated: boolean
  Determines whether the expected response for the tender is updated.
• insertDate: insertDate
  Read Only: true

  insert date
• isStepTender: string
  No description.
• isTenderCount: boolean
  No description.
• iTransactionNo: number (int64)
  No description.
• links: array links
  Read Only: true
• marketCost: marketCost
  Market cost based on the shipment.
• originalPickupTime: originalPickupTime
  No description.
• originLocation: string
  A unique identifier to define the locations withing GC3. The gid contains the domain portion.
• plannedCost: plannedCost
  Copied planning cost from shipment.
• processControlRequestId: number (int64)
  No description.
• rateGeoGid: string
  References the rate record that that is associated with the tender.
• serviceProviders: serviceProviders
• shipmentGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• shipmentShipUnits: shipmentShipUnits
• shipmentTime: shipmentTime
  No description.
• statuses: statuses
• stepResponseTime: stepResponseTime
  No description.
• stepResponseTimeBase: number (int64)
  No description.
• stepResponseTimeUomCode: string
  No description.
• stepTenderPcrId: number (int64)
  No description.
• tenderType: string
  Defines the type of tender. Values are 'Ordinary', 'Broadcast Tender', and 'Spot Bid'
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "iTransactionNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "tenderType":{
            "description":"Defines the type of tender. Values are 'Ordinary', 'Broadcast Tender', and 'Spot Bid'",
            "type":"string"
        },
        "shipmentTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "expectedResponse":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "originLocation":{
            "description":"A unique identifier to define the locations withing GC3. The gid contains the domain portion.",
            "type":"string"
        },
        "destinationLocation":{
            "description":"A unique identifier to define the locations withing GC3. The gid contains the domain portion.",
            "type":"string"
        },
        "deliveryTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "originalPickupTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isTenderCount":{
            "description":"No description.",
            "type":"boolean"
        },
        "rateGeoGid":{
            "description":"References the rate record that that is associated with the tender.",
            "type":"string"
        },
        "plannedCost":{
            "description":"Copied planning cost from shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "processControlRequestId":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "isStepTender":{
            "description":"No description.",
            "type":"string"
        },
        "stepResponseTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "stepResponseTimeUomCode":{
            "description":"No description.",
            "type":"string"
        },
        "stepResponseTimeBase":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "stepTenderPcrId":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "expectedRespUpdated":{
            "description":"Determines whether the expected response for the tender is updated.",
            "type":"boolean"
        },
        "marketCost":{
            "description":"Market cost based on the shipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tenders.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "serviceProviders":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tenders.serviceProviders"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipmentShipUnits":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tenders.shipmentShipUnits"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "conditionalBookingFields":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tenders.conditionalBookingFields"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : conditionalBookingFields

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tenders.conditionalBookingFields"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : deliveryTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : expectedResponse

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : marketCost

Market cost based on the shipment.

Match All

Show Source

• object currencyType

{
    "description":"Market cost based on the shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : originalPickupTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : plannedCost

Copied planning cost from shipment.

Match All

Show Source

• object currencyType

{
    "description":"Copied planning cost from shipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : serviceProviders

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tenders.serviceProviders"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : shipmentShipUnits

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tenders.shipmentShipUnits"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : shipmentTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tenders.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : stepResponseTime

No description.

Match All

Show Source

• object amountType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tenders.conditionalBookingFields

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tenders.conditionalBookingFields"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tenders.conditionalBookingFields

Type: object

Show Source

• conditionalBookingFieldGid: string
  No description.
• conditionalBookingProfGid: string
  No description.
• domainName: string
  No description.
• isPlannerApproved: boolean
  No description.
• links: array links
  Read Only: true
• locationAlias: string
  No description.
• locationGid: string
  No description.
• locationLongName: string
  No description.
• locationQualifierGid: string
  No description.
• plannerValue: string
  No description.
• servprovValue: string
  No description.
• stopNumber: number (int32)
  No description.
• timeQualifierGid: string
  No description.
• transportStageQualifierGid: string
  No description.
• uomCode: string
  No description.

{
    "properties":{
        "conditionalBookingFieldGid":{
            "description":"No description.",
            "type":"string"
        },
        "stopNumber":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "plannerValue":{
            "description":"No description.",
            "type":"string"
        },
        "servprovValue":{
            "description":"No description.",
            "type":"string"
        },
        "uomCode":{
            "description":"No description.",
            "type":"string"
        },
        "isPlannerApproved":{
            "description":"No description.",
            "type":"boolean"
        },
        "conditionalBookingProfGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "locationGid":{
            "description":"No description.",
            "type":"string"
        },
        "locationLongName":{
            "description":"No description.",
            "type":"string"
        },
        "locationAlias":{
            "description":"No description.",
            "type":"string"
        },
        "locationQualifierGid":{
            "description":"No description.",
            "type":"string"
        },
        "timeQualifierGid":{
            "description":"No description.",
            "type":"string"
        },
        "transportStageQualifierGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

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

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

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 tenders.serviceProviders

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tenders.serviceProviders"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tenders.serviceProviders

Type: object

Show Source

• acceptanceCode: string
  Tender acceptance status for a shipment. Values are A (Tender Accepted), D (Tender Declined), C (Tender Conditionally Accepted) and P (Tender Partially Accepted).
• bidAmount: bidAmount
  The amount of the bid indicated by this service provider
• bids: bids
• comments: comments
• declineReasonCodeGid: string
  If awarded the reason for the award spot bid other than the lowest bid, and if declined the reason for tender decline.
• dispatchLocationGid: string
  Read Only: true

  The id of the contact of the service provider
• domainName: string
  No description.
• equipments: equipments
• hasBidOptions: boolean
  Field to check if service provider has provided any conditional bidding.
• indicator: string
  Indicator indicating whether or not this service provider has submitted a valid bid. Values are R (red) and G(Green)
• isDigitalFreight: boolean
  If Y, then these spot bid rates are from digital freight user.
• isWinner: boolean
  Read Only: true

  Yes if service provider is the winner, no otherwise. If traditional tender, this is set to Y if / when they accept the tender offer.
• links: array links
  Read Only: true
• pickupTime: pickupTime
  Original value is from shipment, if servprov changes pickup time, it is stored in this column.
• refnums: refnums
• respondingGlUserGid: string
  Read Only: true

  The gluser responding in the collaboration
• responseComMethodGid: string
  The communication method used for the collaboration
• responseITransactionNo: number (int64)
  store the i_transaction_no of in_bound i_transaction when tender response is sent through integration. This attribute is marked as Create-Only.
• responseTime: responseTime
  No description.
• servprovGid: string
  The service provider who received the tender or for spot bidding, the service provider spot bid
• spotAdjustedCost: spotAdjustedCost
  Stores the calculated adjusted cost for the spot bid using the spot rate adjustment factor on the service provider.
• spotRateGeoGid: string
  Spot rate specified while bidding.
• spotRates: spotRates
• tenderComMethodGid: string
  Record the com method used in tender notification.
• transactionTime: transactionTime
  The date of the tender collaboration either tender sent, accept, withdrawal, etc or the last tender spot bid

{
    "properties":{
        "servprovGid":{
            "description":"The service provider who received the tender or for spot bidding, the service provider spot bid",
            "type":"string"
        },
        "transactionTime":{
            "description":"The date of the tender collaboration either tender sent, accept, withdrawal, etc or the last tender spot bid",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "acceptanceCode":{
            "description":"Tender acceptance status for a shipment. Values are A (Tender Accepted), D (Tender Declined), C (Tender Conditionally Accepted) and P (Tender Partially Accepted).",
            "type":"string"
        },
        "responseComMethodGid":{
            "description":"The communication method used for the collaboration",
            "type":"string"
        },
        "respondingGlUserGid":{
            "description":"The gluser responding in the collaboration",
            "type":"string",
            "readOnly":true
        },
        "declineReasonCodeGid":{
            "description":"If awarded the reason for the award spot bid other than the lowest bid, and if declined the reason for tender decline.",
            "type":"string"
        },
        "dispatchLocationGid":{
            "description":"The id of the contact of the service provider",
            "type":"string",
            "readOnly":true
        },
        "bidAmount":{
            "description":"The amount of the bid indicated by this service provider",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "indicator":{
            "description":"Indicator indicating whether or not this service provider has submitted a valid bid.  Values are R (red) and G(Green)",
            "type":"string"
        },
        "isWinner":{
            "description":"Yes if service provider is the winner, no otherwise.  If traditional tender, this is set to Y if / when they accept the tender offer.",
            "type":"boolean",
            "readOnly":true
        },
        "responseITransactionNo":{
            "description":"store the i_transaction_no of in_bound i_transaction when tender response is sent through integration. This attribute is marked as Create-Only.",
            "type":"number",
            "format":"int64"
        },
        "pickupTime":{
            "description":"Original value is from shipment, if servprov changes pickup time, it is stored in this column.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "tenderComMethodGid":{
            "description":"Record the com method used in tender notification.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "responseTime":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "spotAdjustedCost":{
            "description":"Stores the calculated adjusted cost for the spot bid using the spot rate adjustment factor on the service provider.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "hasBidOptions":{
            "description":"Field to check if service provider has provided any conditional bidding.",
            "type":"boolean"
        },
        "spotRateGeoGid":{
            "description":"Spot rate specified while bidding. ",
            "type":"string"
        },
        "isDigitalFreight":{
            "description":"If Y, then these spot bid rates are from digital freight user.",
            "type":"boolean"
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tenders.serviceProviders.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tenders.serviceProviders.equipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "comments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tenders.serviceProviders.comments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "bids":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tenders.serviceProviders.bids"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "spotRates":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/tenders.serviceProviders.spotRates"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : bidAmount

The amount of the bid indicated by this service provider

Match All

Show Source

• object currencyType

{
    "description":"The amount of the bid indicated by this service provider",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : bids

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tenders.serviceProviders.bids"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : comments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tenders.serviceProviders.comments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : equipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tenders.serviceProviders.equipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : pickupTime

Original value is from shipment, if servprov changes pickup time, it is stored in this column.

Match All

Show Source

• object dateTimeType

{
    "description":"Original value is from shipment, if servprov changes pickup time, it is stored in this column.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tenders.serviceProviders.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : responseTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : spotAdjustedCost

Stores the calculated adjusted cost for the spot bid using the spot rate adjustment factor on the service provider.

Match All

Show Source

• object currencyType

{
    "description":"Stores the calculated adjusted cost for the spot bid using the spot rate adjustment factor on the service provider.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : spotRates

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/tenders.serviceProviders.spotRates"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : transactionTime

The date of the tender collaboration either tender sent, accept, withdrawal, etc or the last tender spot bid

Match All

Show Source

• object dateTimeType

{
    "description":"The date of the tender collaboration either tender sent, accept, withdrawal, etc or the last tender spot bid",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object tenders.serviceProviders.bids

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tenders.serviceProviders.bids"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tenders.serviceProviders.bids

Type: object

Show Source

• bidAmount: bidAmount
  The amount of the bid indicated by this service provider. This attribute is marked as Create-Only.
• bidComment: string
  Stores the user comments for each bid.
• deliveryEta: deliveryEta
  The delivery or dropoff date of the shipment stop.
• destLocationGid: string
  The GID of the destination location of the shipment. This attribute is marked as Create-Only.
• domainName: string
  No description.
• flightInstanceId: number (int64)
  Flight Instance ID to be updated to the shipment, if the bid option is approved. This attribute is marked as Create-Only.
• isApproved: boolean
  The bid is approved by planner.
• isDirectRoute: boolean
  Flag to indicate if the proposed flight is direct or not. This attribute is marked as Create-Only.
• links: array links
  Read Only: true
• pickupDate: pickupDate
  The pickup date of the shipment. This attribute is marked as Create-Only.
• sequenceNo: number (int64)
  The sequence identifier for the spot bid. This attribute is marked as Create-Only.
• sourceLocationGid: string
  The GID of the source location of the shipment. This attribute is marked as Create-Only.
• spotRateGid: string
  Spot rate ID specified while creating this bid option.
• tag1: string
  Stores information about the other fields for each bid.
• tag2: string
  Stores information about the other fields for each bid.
• tag3: string
  Stores information about the other fields for each bid.
• transitTime: transitTime
  The transit time for the shipment. This attribute is marked as Create-Only.
• transportModeGid: string
  A unique identifier to define the transportation mode. This attribute is marked as Create-Only.

{
    "properties":{
        "sequenceNo":{
            "description":"The sequence identifier for the spot bid. This attribute is marked as Create-Only.",
            "type":"number",
            "format":"int64"
        },
        "bidAmount":{
            "description":"The amount of the bid indicated by this service provider. This attribute is marked as Create-Only.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "pickupDate":{
            "description":"The pickup date of the shipment. This attribute is marked as Create-Only.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "sourceLocationGid":{
            "description":"The GID of the source location of the shipment.  This attribute is marked as Create-Only.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The GID of the destination location of the shipment.  This attribute is marked as Create-Only.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"A unique identifier to define the transportation mode.  This attribute is marked as Create-Only.",
            "type":"string"
        },
        "transitTime":{
            "description":"The transit time for the shipment. This attribute is marked as Create-Only.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "isApproved":{
            "description":"The bid is approved by planner.",
            "type":"boolean"
        },
        "isDirectRoute":{
            "description":"Flag to indicate if the proposed flight is direct or not. This attribute is marked as Create-Only.",
            "type":"boolean"
        },
        "flightInstanceId":{
            "description":"Flight Instance ID to be updated to the shipment, if the bid option is approved. This attribute is marked as Create-Only.",
            "type":"number",
            "format":"int64"
        },
        "spotRateGid":{
            "description":"Spot rate ID specified while creating this bid option.",
            "type":"string"
        },
        "tag1":{
            "description":"Stores information about the other fields for each bid.",
            "type":"string"
        },
        "tag2":{
            "description":"Stores information about the other fields for each bid.",
            "type":"string"
        },
        "tag3":{
            "description":"Stores information about the other fields for each bid.",
            "type":"string"
        },
        "bidComment":{
            "description":"Stores the user comments for each bid.",
            "type":"string"
        },
        "deliveryEta":{
            "description":"The delivery or dropoff date of the shipment stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : bidAmount

The amount of the bid indicated by this service provider. This attribute is marked as Create-Only.

Match All

Show Source

• object currencyType

{
    "description":"The amount of the bid indicated by this service provider. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : deliveryEta

The delivery or dropoff date of the shipment stop.

Match All

Show Source

• object dateTimeType

{
    "description":"The delivery or dropoff date of the shipment stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : pickupDate

The pickup date of the shipment. This attribute is marked as Create-Only.

Match All

Show Source

• object dateTimeType

{
    "description":"The pickup date of the shipment. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : transitTime

The transit time for the shipment. This attribute is marked as Create-Only.

Match All

Show Source

• object amountType

{
    "description":"The transit time for the shipment. This attribute is marked as Create-Only.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object tenders.serviceProviders.comments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tenders.serviceProviders.comments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tenders.serviceProviders.comments

Type: object

Show Source

• commentQualGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• domainName: string
  No description.
• isConditionalBookingRemark: boolean
  mark the remark as conditional booking.
• links: array links
  Read Only: true
• responseITransactionNo: number (int64)
  in bound transaction no for tender response
• sequence: number (int64)
  No description.
• servprovShipperQual: string
  No description.
• tenderComment: string
  No description.

{
    "properties":{
        "sequence":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "servprovShipperQual":{
            "description":"No description.",
            "type":"string"
        },
        "commentQualGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "tenderComment":{
            "description":"No description.",
            "type":"string"
        },
        "responseITransactionNo":{
            "description":"in bound transaction no for tender response",
            "type":"number",
            "format":"int64"
        },
        "isConditionalBookingRemark":{
            "description":"mark the remark as conditional booking.",
            "type":"boolean"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tenders.serviceProviders.equipments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tenders.serviceProviders.equipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tenders.serviceProviders.equipments

Type: object

Show Source

• checkDigit: number (int32)
  No description.
• domainName: string
  No description.
• equipmentGid: string
  No description.
• equipmentGroupGid: string
  No description.
• equipmentInitial: string
  service provider's equipment initial
• equipmentInitialNumber: string
  service provider's equipment initial and number
• equipmentNumber: string
  service provider's equipment number
• equipmentTypeGid: string
  No description.
• licensePlate: string
  No description.
• links: array links
  Read Only: true
• responseITransactionNo: number (int64)
  No description.
• sequence: number (int64)
  No description.
• sEquipmentGid: string
  used to match s_equipment of a shipment.
• servprovStatus: string
  A for accept, R for reject, N for new.

{
    "properties":{
        "sequence":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "sEquipmentGid":{
            "description":"used to match s_equipment of a shipment.",
            "type":"string"
        },
        "equipmentInitial":{
            "description":"service provider's equipment initial",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"service provider's equipment number",
            "type":"string"
        },
        "equipmentInitialNumber":{
            "description":"service provider's equipment initial and number",
            "type":"string"
        },
        "responseITransactionNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "equipmentTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "equipmentGroupGid":{
            "description":"No description.",
            "type":"string"
        },
        "equipmentGid":{
            "description":"No description.",
            "type":"string"
        },
        "servprovStatus":{
            "description":"A for accept, R for reject, N for new.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "checkDigit":{
            "description":"No description.",
            "type":"number",
            "format":"int32"
        },
        "licensePlate":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tenders.serviceProviders.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tenders.serviceProviders.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tenders.serviceProviders.refnums

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• responseITransactionNo: number (int64)
  No description.
• tenderShipmentRefnum: string
  No description.
• tenderShipmentRefnumQual: string
  No description.
• tenderShipmentRefnumQualD: string
  No description.

{
    "properties":{
        "tenderShipmentRefnumQual":{
            "description":"No description.",
            "type":"string"
        },
        "tenderShipmentRefnum":{
            "description":"No description.",
            "type":"string"
        },
        "tenderShipmentRefnumQualD":{
            "description":"No description.",
            "type":"string"
        },
        "responseITransactionNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tenders.serviceProviders.spotRates

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tenders.serviceProviders.spotRates"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tenders.serviceProviders.spotRates

Type: object

Show Source

• chargeAmount1: chargeAmount1
  The charge amount for this spot cost.
• chargeAmount2: chargeAmount2
  No description.
• chargeAmount3: chargeAmount3
  No description.
• chargeMultiplier1: string
  The cost operand for the charge amount.
• chargeMultiplier2: string
  No description.
• chargeMultiplier3: string
  No description.
• chargeUnit1Count: number (double)
  The unit value to be used in association with the charge multiplier.
• chargeUnit1UomCode: string
  UOM code for the charge unit field.
• chargeUnit2Count: number (double)
  No description.
• chargeUnit2UomCode: string
  No description.
• chargeUnit3Count: number (double)
  No description.
• chargeUnit3UomCode: string
  No description.
• domainName: string
  No description.
• isApproved: boolean
  This field will be updated as Y, if this spot cost gets approved.
• links: array links
  Read Only: true
• spotRateGid: string
  ID of the Spot Rate created during the bidding process.
• spotRateOfferingGid: string
  The SPOT_RATE_OFFERING linked to this service provider.

{
    "properties":{
        "spotRateGid":{
            "description":"ID of the Spot Rate created during the bidding process.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "spotRateOfferingGid":{
            "description":"The SPOT_RATE_OFFERING linked to this service provider.",
            "type":"string"
        },
        "chargeAmount1":{
            "description":"The charge amount for this spot cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "chargeMultiplier1":{
            "description":"The cost operand for the charge amount.",
            "type":"string"
        },
        "chargeUnit1Count":{
            "description":"The unit value to be used in association with the charge multiplier.",
            "type":"number",
            "format":"double"
        },
        "chargeUnit1UomCode":{
            "description":"UOM code for the charge unit field.",
            "type":"string"
        },
        "isApproved":{
            "description":"This field will be updated as Y, if this spot cost gets approved.",
            "type":"boolean"
        },
        "chargeAmount2":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "chargeMultiplier2":{
            "description":"No description.",
            "type":"string"
        },
        "chargeUnit2Count":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "chargeUnit2UomCode":{
            "description":"No description.",
            "type":"string"
        },
        "chargeAmount3":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "chargeMultiplier3":{
            "description":"No description.",
            "type":"string"
        },
        "chargeUnit3Count":{
            "description":"No description.",
            "type":"number",
            "format":"double"
        },
        "chargeUnit3UomCode":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : chargeAmount1

The charge amount for this spot cost.

Match All

Show Source

• object currencyType

{
    "description":"The charge amount for this spot cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : chargeAmount2

No description.

Match All

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : chargeAmount3

No description.

Match All

Show Source

• object currencyType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tenders.shipmentShipUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tenders.shipmentShipUnits"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tenders.shipmentShipUnits

Type: object

Show Source

• acceptanceCount: number (int64)
  No description.
• acceptQuantity: number (int64)
  No description.
• availableQuantity: number (int64)
  No description.
• domainName: string
  No description.
• equipmentInfo: string
  No description.
• links: array links
  Read Only: true
• sShipUnitGid: string
  No description.

{
    "properties":{
        "sShipUnitGid":{
            "description":"No description.",
            "type":"string"
        },
        "acceptanceCount":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "availableQuantity":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "acceptQuantity":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "equipmentInfo":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object tenders.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/tenders.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : tenders.statuses

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• statusTypeGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• statusValueGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.

{
    "properties":{
        "statusTypeGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Back to Top