Jump to

• Request
• Response

Create a Ship Unit

post

/quotes/{quoteGid}/shipUnits

Request

Path Parameters

• quoteGid(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/quotes.shipUnits"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/quotes.shipUnits"
    }
}

Nested Schema : schema

Type: object

Show Source

• commodityGid: string
  The unique identifier for the commodity.
• commodityType: string
  The type of commodity.
• declaredValue: declaredValue
  Declared value.
• domainName: string
  Database domain where this data is stored.
• exportHtsGid: string
  The unique identifier for the export Harmonized Tariff System (HTS).
• height: height
  Height.
• htsGid: string
  The GID for the Harmonized Tariff Schedule (HTS). Not used by OTM - all cross border compliance related classifications are handled by GTM.
• iataScrCodeGid: string
  n/a
• isSplitable: boolean
  Flag to indicate if the quantity for this item is splittable.
• itemGid: string
  The GID for the item.
• length: length
  Length.
• links: array links
  Read Only: true
• nmfcClassGid: string
  The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc.
• sequence: number (int32)
  Sequence number for the ship unit.
• shipUnitCount: number (int32)
  Count of transport handling units.
• sitcGid: string
  The GID for the Standard International Trade Classification (SITC) is a classification of goods used to classify the exports and imports of a country to enable comparing different countries and years. The classification system is maintained by the United Nations. Not used by OTM - all cross border compliance related classifications are handled by GTM.
• stccGid: string
  The GID for the Standard Transportation Commodity Code (STCC).
• transportHandlingUnitGid: string
  The GID for the transport handling unit.
• udcClassificationListGid: string
  The GID for the user defined commodity code list.
• userDefinedCommodityGid: string
  The GID for the user defined commodity code.
• volume: volume
  Volume.
• weight: weight
  Weight.
• width: width
  Width.

{
    "properties":{
        "sequence":{
            "description":"Sequence number for the ship unit.",
            "type":"number",
            "format":"int32"
        },
        "commodityType":{
            "description":"The type of commodity.",
            "type":"string"
        },
        "itemGid":{
            "description":"The GID for the item.",
            "type":"string"
        },
        "nmfcClassGid":{
            "description":"The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc. ",
            "type":"string"
        },
        "stccGid":{
            "description":"The GID for the Standard Transportation Commodity Code (STCC).",
            "type":"string"
        },
        "sitcGid":{
            "description":"The GID for the Standard International Trade Classification (SITC) is a classification of goods used to classify the exports and imports of a country to enable comparing different countries and years. The classification system is maintained by the United Nations. Not used by OTM - all cross border compliance related classifications are handled by GTM.",
            "type":"string"
        },
        "htsGid":{
            "description":"The GID for the Harmonized Tariff Schedule (HTS). Not used by OTM - all cross border compliance related classifications are handled by GTM.",
            "type":"string"
        },
        "userDefinedCommodityGid":{
            "description":"The GID for the user defined commodity code.",
            "type":"string"
        },
        "udcClassificationListGid":{
            "description":"The GID for the user defined commodity code list.",
            "type":"string"
        },
        "weight":{
            "description":"Weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"Volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isSplitable":{
            "description":"Flag to indicate if the quantity for this item is splittable.",
            "type":"boolean"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit.",
            "type":"string"
        },
        "shipUnitCount":{
            "description":"Count of transport handling units.",
            "type":"number",
            "format":"int32"
        },
        "length":{
            "description":"Length.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"Width.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"Height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "declaredValue":{
            "description":"Declared value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "iataScrCodeGid":{
            "description":"n/a",
            "type":"string"
        },
        "commodityGid":{
            "description":"The unique identifier for the commodity.",
            "type":"string"
        },
        "exportHtsGid":{
            "description":"The unique identifier for the export Harmonized Tariff System (HTS).",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

Declared value.

Match All

Show Source

• object currencyType

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

Nested Schema : height

Height.

Match All

Show Source

• object amountType

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

Nested Schema : length

Length.

Match All

Show Source

• object amountType

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

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

Volume.

Match All

Show Source

• object amountType

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

Nested Schema : weight

Weight.

Match All

Show Source

• object amountType

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

Nested Schema : width

Width.

Match All

Show Source

• object amountType

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

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

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

Root Schema : schema

Type: object

Show Source

• commodityGid: string
  The unique identifier for the commodity.
• commodityType: string
  The type of commodity.
• declaredValue: declaredValue
  Declared value.
• domainName: string
  Database domain where this data is stored.
• exportHtsGid: string
  The unique identifier for the export Harmonized Tariff System (HTS).
• height: height
  Height.
• htsGid: string
  The GID for the Harmonized Tariff Schedule (HTS). Not used by OTM - all cross border compliance related classifications are handled by GTM.
• iataScrCodeGid: string
  n/a
• isSplitable: boolean
  Flag to indicate if the quantity for this item is splittable.
• itemGid: string
  The GID for the item.
• length: length
  Length.
• links: array links
  Read Only: true
• nmfcClassGid: string
  The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc.
• sequence: number (int32)
  Sequence number for the ship unit.
• shipUnitCount: number (int32)
  Count of transport handling units.
• sitcGid: string
  The GID for the Standard International Trade Classification (SITC) is a classification of goods used to classify the exports and imports of a country to enable comparing different countries and years. The classification system is maintained by the United Nations. Not used by OTM - all cross border compliance related classifications are handled by GTM.
• stccGid: string
  The GID for the Standard Transportation Commodity Code (STCC).
• transportHandlingUnitGid: string
  The GID for the transport handling unit.
• udcClassificationListGid: string
  The GID for the user defined commodity code list.
• userDefinedCommodityGid: string
  The GID for the user defined commodity code.
• volume: volume
  Volume.
• weight: weight
  Weight.
• width: width
  Width.

{
    "properties":{
        "sequence":{
            "description":"Sequence number for the ship unit.",
            "type":"number",
            "format":"int32"
        },
        "commodityType":{
            "description":"The type of commodity.",
            "type":"string"
        },
        "itemGid":{
            "description":"The GID for the item.",
            "type":"string"
        },
        "nmfcClassGid":{
            "description":"The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc. ",
            "type":"string"
        },
        "stccGid":{
            "description":"The GID for the Standard Transportation Commodity Code (STCC).",
            "type":"string"
        },
        "sitcGid":{
            "description":"The GID for the Standard International Trade Classification (SITC) is a classification of goods used to classify the exports and imports of a country to enable comparing different countries and years. The classification system is maintained by the United Nations. Not used by OTM - all cross border compliance related classifications are handled by GTM.",
            "type":"string"
        },
        "htsGid":{
            "description":"The GID for the Harmonized Tariff Schedule (HTS). Not used by OTM - all cross border compliance related classifications are handled by GTM.",
            "type":"string"
        },
        "userDefinedCommodityGid":{
            "description":"The GID for the user defined commodity code.",
            "type":"string"
        },
        "udcClassificationListGid":{
            "description":"The GID for the user defined commodity code list.",
            "type":"string"
        },
        "weight":{
            "description":"Weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"Volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isSplitable":{
            "description":"Flag to indicate if the quantity for this item is splittable.",
            "type":"boolean"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit.",
            "type":"string"
        },
        "shipUnitCount":{
            "description":"Count of transport handling units.",
            "type":"number",
            "format":"int32"
        },
        "length":{
            "description":"Length.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"Width.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"Height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "declaredValue":{
            "description":"Declared value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "iataScrCodeGid":{
            "description":"n/a",
            "type":"string"
        },
        "commodityGid":{
            "description":"The unique identifier for the commodity.",
            "type":"string"
        },
        "exportHtsGid":{
            "description":"The unique identifier for the export Harmonized Tariff System (HTS).",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

Declared value.

Match All

Show Source

• object currencyType

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

Nested Schema : height

Height.

Match All

Show Source

• object amountType

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

Nested Schema : length

Length.

Match All

Show Source

• object amountType

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

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

Volume.

Match All

Show Source

• object amountType

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

Nested Schema : weight

Weight.

Match All

Show Source

• object amountType

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

Nested Schema : width

Width.

Match All

Show Source

• object amountType

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

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

• commodityGid: string
  The unique identifier for the commodity.
• commodityType: string
  The type of commodity.
• declaredValue: declaredValue
  Declared value.
• domainName: string
  Database domain where this data is stored.
• exportHtsGid: string
  The unique identifier for the export Harmonized Tariff System (HTS).
• height: height
  Height.
• htsGid: string
  The GID for the Harmonized Tariff Schedule (HTS). Not used by OTM - all cross border compliance related classifications are handled by GTM.
• iataScrCodeGid: string
  n/a
• isSplitable: boolean
  Flag to indicate if the quantity for this item is splittable.
• itemGid: string
  The GID for the item.
• length: length
  Length.
• links: array links
  Read Only: true
• nmfcClassGid: string
  The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc.
• sequence: number (int32)
  Sequence number for the ship unit.
• shipUnitCount: number (int32)
  Count of transport handling units.
• sitcGid: string
  The GID for the Standard International Trade Classification (SITC) is a classification of goods used to classify the exports and imports of a country to enable comparing different countries and years. The classification system is maintained by the United Nations. Not used by OTM - all cross border compliance related classifications are handled by GTM.
• stccGid: string
  The GID for the Standard Transportation Commodity Code (STCC).
• transportHandlingUnitGid: string
  The GID for the transport handling unit.
• udcClassificationListGid: string
  The GID for the user defined commodity code list.
• userDefinedCommodityGid: string
  The GID for the user defined commodity code.
• volume: volume
  Volume.
• weight: weight
  Weight.
• width: width
  Width.

{
    "properties":{
        "sequence":{
            "description":"Sequence number for the ship unit.",
            "type":"number",
            "format":"int32"
        },
        "commodityType":{
            "description":"The type of commodity.",
            "type":"string"
        },
        "itemGid":{
            "description":"The GID for the item.",
            "type":"string"
        },
        "nmfcClassGid":{
            "description":"The GID for the National Motor Freight Classification (NMFC). The NMFC is a critical piece of information used for rating Less-Than-Truckload shipments in North America. If you intend to rate shipments using RATEWAREXL or RATEWAREXL WITH CARRIERCONNECT it's important that the NMFC class information entered is a standard NMFC freight class - for example, 50, 55, 60, 65, 70, 77.5 etc. ",
            "type":"string"
        },
        "stccGid":{
            "description":"The GID for the Standard Transportation Commodity Code (STCC).",
            "type":"string"
        },
        "sitcGid":{
            "description":"The GID for the Standard International Trade Classification (SITC) is a classification of goods used to classify the exports and imports of a country to enable comparing different countries and years. The classification system is maintained by the United Nations. Not used by OTM - all cross border compliance related classifications are handled by GTM.",
            "type":"string"
        },
        "htsGid":{
            "description":"The GID for the Harmonized Tariff Schedule (HTS). Not used by OTM - all cross border compliance related classifications are handled by GTM.",
            "type":"string"
        },
        "userDefinedCommodityGid":{
            "description":"The GID for the user defined commodity code.",
            "type":"string"
        },
        "udcClassificationListGid":{
            "description":"The GID for the user defined commodity code list.",
            "type":"string"
        },
        "weight":{
            "description":"Weight.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"Volume.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isSplitable":{
            "description":"Flag to indicate if the quantity for this item is splittable.",
            "type":"boolean"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit.",
            "type":"string"
        },
        "shipUnitCount":{
            "description":"Count of transport handling units.",
            "type":"number",
            "format":"int32"
        },
        "length":{
            "description":"Length.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"Width.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"Height.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "declaredValue":{
            "description":"Declared value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "iataScrCodeGid":{
            "description":"n/a",
            "type":"string"
        },
        "commodityGid":{
            "description":"The unique identifier for the commodity.",
            "type":"string"
        },
        "exportHtsGid":{
            "description":"The unique identifier for the export Harmonized Tariff System (HTS).",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

Declared value.

Match All

Show Source

• object currencyType

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

Nested Schema : height

Height.

Match All

Show Source

• object amountType

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

Nested Schema : length

Length.

Match All

Show Source

• object amountType

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

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

Volume.

Match All

Show Source

• object amountType

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

Nested Schema : weight

Weight.

Match All

Show Source

• object amountType

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

Nested Schema : width

Width.

Match All

Show Source

• object amountType

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

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Back to Top