Jump to

• Request
• Response

Get an Equipment Detail

get

/invoices/{invoiceGid}/equipmentDetails/{seqNumber}

Request

Path Parameters

• invoiceGid(required): string
  Resource ID
• seqNumber(required): string
  Resource ID

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• descriptionCode: string
  Description code.
• domainName: string
  Database domain where this data is stored.
• dunnage: dunnage
  Dunnage.
• equipmentInitialNumber: string
  The Equipment Initial/Number field is a concatenation of equipment initial and equipment number. The initial is a mark that is registered with national or international authorities that is associated with a specific owner.
• equipmentNumber: string
  The number for the equipment. This attribute is marked as Create-Only.
• equipmentOwnerIdentifier: string
  The identifier of the equipment owner.
• equipmentPrefix: string
  The prefix of the equipment that was used for the shipment that relates to this invoice. This attribute is marked as Create-Only.
• height: height
  The height of the equipment.
• isoEquipmentTypeIdentifier: string
  The ISO equipment type identifier.
• length: length
  The length of the equipment.
• links: array links
  Read Only: true
• maximumTemperature: maximumTemperature
  The maximum temperature for the equipment.
• minimumTemperature: minimumTemperature
  The minimum temperature for the equipment.
• ownershipCode: string
  Ownership code.
• percentHumidityAllowed: number (int32)
  The maximum percentage of humidity allowed for the equipment.
• seals: seals
• seqNumber: number (int64)
  Read Only: true

  Internal database sequence number related to each invoice equipment entry.
• sEquipmentGid: string
  The GID for the shipment equipment.
• tareWeight: tareWeight
  Weight of equipment when empty.
• unitCount: number (int64)
  Unit count.
• ventSettingCode: string
  The vent setting code.
• volume: volume
  The volume of the equipment.
• weight: weight
  The weight of the equipment.
• weightAllowance: weightAllowance
  The regulatory maximum weight for the equipment.
• weightQualifier: string
  Weight qualifier.
• width: width
  The width of the equipment.

{
    "properties":{
        "seqNumber":{
            "description":"Internal database sequence number related to each invoice equipment entry.",
            "type":"number",
            "format":"int64",
            "readOnly":true
        },
        "equipmentInitialNumber":{
            "description":"The Equipment Initial/Number field is a concatenation of equipment initial and equipment number. The initial is a mark that is registered with national or international authorities that is associated with a specific owner.",
            "type":"string"
        },
        "sEquipmentGid":{
            "description":"The GID for the shipment equipment.",
            "type":"string"
        },
        "equipmentPrefix":{
            "description":"The prefix of the equipment that was used for the shipment that relates to this invoice. This attribute is marked as Create-Only.",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"The number for the equipment. This attribute is marked as Create-Only.",
            "type":"string"
        },
        "isoEquipmentTypeIdentifier":{
            "description":"The ISO equipment type identifier.",
            "type":"string"
        },
        "descriptionCode":{
            "description":"Description code.",
            "type":"string"
        },
        "equipmentOwnerIdentifier":{
            "description":"The identifier of the equipment owner.",
            "type":"string"
        },
        "ownershipCode":{
            "description":"Ownership code.",
            "type":"string"
        },
        "length":{
            "description":"The length of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"The width of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"The height of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weight":{
            "description":"The weight of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tareWeight":{
            "description":"Weight of equipment when empty.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "dunnage":{
            "description":"Dunnage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitCount":{
            "description":"Unit count.",
            "type":"number",
            "format":"int64"
        },
        "weightQualifier":{
            "description":"Weight qualifier.",
            "type":"string"
        },
        "minimumTemperature":{
            "description":"The minimum temperature for the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maximumTemperature":{
            "description":"The maximum temperature for the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "percentHumidityAllowed":{
            "description":"The maximum percentage of humidity allowed for the equipment.",
            "type":"number",
            "format":"int32"
        },
        "ventSettingCode":{
            "description":"The vent setting code.",
            "type":"string"
        },
        "weightAllowance":{
            "description":"The regulatory maximum weight for the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.equipmentDetails.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : dunnage

Dunnage.

Match All

Show Source

• object amountType

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

Nested Schema : height

The height of the equipment.

Match All

Show Source

• object amountType

{
    "description":"The height of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : length

The length of the equipment.

Match All

Show Source

• object amountType

{
    "description":"The length of the equipment.",
    "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 : maximumTemperature

The maximum temperature for the equipment.

Match All

Show Source

• object amountType

{
    "description":"The maximum temperature for the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minimumTemperature

The minimum temperature for the equipment.

Match All

Show Source

• object amountType

{
    "description":"The minimum temperature for the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : seals

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.equipmentDetails.seals"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tareWeight

Weight of equipment when empty.

Match All

Show Source

• object amountType

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

Nested Schema : volume

The volume of the equipment.

Match All

Show Source

• object amountType

{
    "description":"The volume of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The weight of the equipment.

Match All

Show Source

• object amountType

{
    "description":"The weight of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weightAllowance

The regulatory maximum weight for the equipment.

Match All

Show Source

• object amountType

{
    "description":"The regulatory maximum weight for the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

The width of the equipment.

Match All

Show Source

• object amountType

{
    "description":"The width of the equipment.",
    "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 : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.equipmentDetails.seals

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.equipmentDetails.seals"
    }
}

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 : invoices.equipmentDetails.seals

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• sealNumber: string
  The identification number for equipment that has been sealed.
• sealSequence: number (int32)
  Seal sequence number.

{
    "properties":{
        "sealSequence":{
            "description":"Seal sequence number.",
            "type":"number",
            "format":"int32"
        },
        "sealNumber":{
            "description":"The identification number for equipment that has been sealed.",
            "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 : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

Back to Top