Jump to

• Request
• Response

Create a Line

post

/trackingEvents/{iTransactionNo}/shipUnits/{sShipUnitGid}/lines

Request

Path Parameters

• iTransactionNo(required): string
  Resource ID
• sShipUnitGid(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/trackingEvents.shipUnits.lines"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

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

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagedItemGid: string
  The packaging item defined for the shipping line.
• packagingUnitGid: string
  The packaging unit associated with the packaging item.
• receivedCountPerShipUnit: number (int64)
  The received item count in eaches on a per ship unit received recorded on the tracking event for the shipment ship unit line.
• receivedItemPackageCount: number (int64)
  The received item count in eaches recorded on the tracking event for the shipment ship unit line.
• receivedPackagingUnitCount: number (int64)
  The received item count in terms of packaging units recorded on the tracking event for the shipment ship unit line.
• receivedVolume: receivedVolume
  The received volume recorded on the tracking event for the shipment ship unit line.
• receivedWeight: receivedWeight
  The received weight recorded on the tracking event for the shipment ship unit line.
• sShipUnitLineNo: number (int64)
  The shipment ship unit line associated with the tracking event being reported.

{
    "properties":{
        "sShipUnitLineNo":{
            "description":"The shipment ship unit line associated with the tracking event being reported.",
            "type":"number",
            "format":"int64"
        },
        "packagedItemGid":{
            "description":"The packaging item defined for the shipping line.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The packaging unit associated with the packaging item.",
            "type":"string"
        },
        "receivedWeight":{
            "description":"The received weight recorded on the tracking event for the shipment ship unit line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedVolume":{
            "description":"The received volume recorded on the tracking event for the shipment ship unit line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedItemPackageCount":{
            "description":"The received item count in eaches recorded on the tracking event for the shipment ship unit line.",
            "type":"number",
            "format":"int64"
        },
        "receivedPackagingUnitCount":{
            "description":"The received item count in terms of packaging units recorded on the tracking event for the shipment ship unit line.",
            "type":"number",
            "format":"int64"
        },
        "receivedCountPerShipUnit":{
            "description":"The received item count in eaches on a per ship unit received recorded on the tracking event for the shipment ship unit line.",
            "type":"number",
            "format":"int64"
        },
        "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
}

Nested Schema : receivedVolume

The received volume recorded on the tracking event for the shipment ship unit line.

Match All

Show Source

• object amountType

{
    "description":"The received volume recorded on the tracking event for the shipment ship unit line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : receivedWeight

The received weight recorded on the tracking event for the shipment ship unit line.

Match All

Show Source

• object amountType

{
    "description":"The received weight recorded on the tracking event for the shipment ship unit line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagedItemGid: string
  The packaging item defined for the shipping line.
• packagingUnitGid: string
  The packaging unit associated with the packaging item.
• receivedCountPerShipUnit: number (int64)
  The received item count in eaches on a per ship unit received recorded on the tracking event for the shipment ship unit line.
• receivedItemPackageCount: number (int64)
  The received item count in eaches recorded on the tracking event for the shipment ship unit line.
• receivedPackagingUnitCount: number (int64)
  The received item count in terms of packaging units recorded on the tracking event for the shipment ship unit line.
• receivedVolume: receivedVolume
  The received volume recorded on the tracking event for the shipment ship unit line.
• receivedWeight: receivedWeight
  The received weight recorded on the tracking event for the shipment ship unit line.
• sShipUnitLineNo: number (int64)
  The shipment ship unit line associated with the tracking event being reported.

{
    "properties":{
        "sShipUnitLineNo":{
            "description":"The shipment ship unit line associated with the tracking event being reported.",
            "type":"number",
            "format":"int64"
        },
        "packagedItemGid":{
            "description":"The packaging item defined for the shipping line.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The packaging unit associated with the packaging item.",
            "type":"string"
        },
        "receivedWeight":{
            "description":"The received weight recorded on the tracking event for the shipment ship unit line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedVolume":{
            "description":"The received volume recorded on the tracking event for the shipment ship unit line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedItemPackageCount":{
            "description":"The received item count in eaches recorded on the tracking event for the shipment ship unit line.",
            "type":"number",
            "format":"int64"
        },
        "receivedPackagingUnitCount":{
            "description":"The received item count in terms of packaging units recorded on the tracking event for the shipment ship unit line.",
            "type":"number",
            "format":"int64"
        },
        "receivedCountPerShipUnit":{
            "description":"The received item count in eaches on a per ship unit received recorded on the tracking event for the shipment ship unit line.",
            "type":"number",
            "format":"int64"
        },
        "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
}

Nested Schema : receivedVolume

The received volume recorded on the tracking event for the shipment ship unit line.

Match All

Show Source

• object amountType

{
    "description":"The received volume recorded on the tracking event for the shipment ship unit line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : receivedWeight

The received weight recorded on the tracking event for the shipment ship unit line.

Match All

Show Source

• object amountType

{
    "description":"The received weight recorded on the tracking event for the shipment ship unit line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• packagedItemGid: string
  The packaging item defined for the shipping line.
• packagingUnitGid: string
  The packaging unit associated with the packaging item.
• receivedCountPerShipUnit: number (int64)
  The received item count in eaches on a per ship unit received recorded on the tracking event for the shipment ship unit line.
• receivedItemPackageCount: number (int64)
  The received item count in eaches recorded on the tracking event for the shipment ship unit line.
• receivedPackagingUnitCount: number (int64)
  The received item count in terms of packaging units recorded on the tracking event for the shipment ship unit line.
• receivedVolume: receivedVolume
  The received volume recorded on the tracking event for the shipment ship unit line.
• receivedWeight: receivedWeight
  The received weight recorded on the tracking event for the shipment ship unit line.
• sShipUnitLineNo: number (int64)
  The shipment ship unit line associated with the tracking event being reported.

{
    "properties":{
        "sShipUnitLineNo":{
            "description":"The shipment ship unit line associated with the tracking event being reported.",
            "type":"number",
            "format":"int64"
        },
        "packagedItemGid":{
            "description":"The packaging item defined for the shipping line.",
            "type":"string"
        },
        "packagingUnitGid":{
            "description":"The packaging unit associated with the packaging item.",
            "type":"string"
        },
        "receivedWeight":{
            "description":"The received weight recorded on the tracking event for the shipment ship unit line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedVolume":{
            "description":"The received volume recorded on the tracking event for the shipment ship unit line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "receivedItemPackageCount":{
            "description":"The received item count in eaches recorded on the tracking event for the shipment ship unit line.",
            "type":"number",
            "format":"int64"
        },
        "receivedPackagingUnitCount":{
            "description":"The received item count in terms of packaging units recorded on the tracking event for the shipment ship unit line.",
            "type":"number",
            "format":"int64"
        },
        "receivedCountPerShipUnit":{
            "description":"The received item count in eaches on a per ship unit received recorded on the tracking event for the shipment ship unit line.",
            "type":"number",
            "format":"int64"
        },
        "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
}

Nested Schema : receivedVolume

The received volume recorded on the tracking event for the shipment ship unit line.

Match All

Show Source

• object amountType

{
    "description":"The received volume recorded on the tracking event for the shipment ship unit line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : receivedWeight

The received weight recorded on the tracking event for the shipment ship unit line.

Match All

Show Source

• object amountType

{
    "description":"The received weight recorded on the tracking event for the shipment ship unit line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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