Jump to

• Request
• Response

Create a Tender

post

/shipments/{shipmentGid}/tenders

Request

Path Parameters

• shipmentGid(required): string
  Resource ID

Supported Media Types

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

Request Body - application/vnd.oracle.resource+json;type=collection ()

Root Schema : schema

Type: object

Show Source

• items(required): array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object schema

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

Nested Schema : schema

Type: object

Show Source

• 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.
• 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.
• shipmentTime: shipmentTime
  No description.
• 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'

{
    "properties":{
        "iTransactionNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "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"
                }
            ]
        },
        "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 : 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 : shipmentTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : stepResponseTime

No description.

Match All

Show Source

• object amountType

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

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

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "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"
        }
    }
}

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

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• shipmentTime: shipmentTime
  No description.
• 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'

{
    "properties":{
        "iTransactionNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "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"
                }
            ]
        },
        "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 : 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 : shipmentTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : stepResponseTime

No description.

Match All

Show Source

• object amountType

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

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

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "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"
        }
    }
}

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

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• shipmentTime: shipmentTime
  No description.
• 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'

{
    "properties":{
        "iTransactionNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "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"
                }
            ]
        },
        "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 : 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 : shipmentTime

No description.

Match All

Show Source

• object dateTimeType

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

Nested Schema : stepResponseTime

No description.

Match All

Show Source

• object amountType

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

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

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "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"
        }
    }
}

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

Back to Top