Jump to

• Request
• Response

Get Contents

get

/orderBases/{orderBaseGid}/shipUnits/{obShipUnitGid}/contents

Request

Path Parameters

• obShipUnitGid(required): string
  Resource ID
• orderBaseGid(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.
• 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/orderBases.shipUnits.contents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.contents

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : orderBases.shipUnits.contents

Type: object

Show Source

• attributes: attributes
• countPerShipUnit: number (int64)
  The packaged item count per ship unit order base content line count to handle shipping a multiple count number of ship units.
• declaredValue: declaredValue
  The declared value, commercial value of the ship unit line contents for sale of goods.
• domainName: string
  Database domain where this data is stored.
• initialItemGid: string
  The initial packaged item GID, this value can be used to handle the original packaged item order and the substituted and item to be processed in the packaged item GID field.
• involvedParties: involvedParties
• links: array links
  Read Only: true
• packagedCount: number (int64)
  The number of packages in this order release ship unit line for one ship unit. Its ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each order release ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.
• packagedItemGid: string
  The packaged item GID defining the content line for the ship unit.
• packagingUnitCount: number (int64)
  The packaging unit count for the inner pack.
• packagingUnitGid: string
  The packaging unit identifier for any inner packaging associated to the ship unit such as carton configuration.
• refnums: refnums
• remarks: remarks
• sequenceNo: number (int64)
  The unique sequence within the ship unit to define the individual line items.
• tag1: string
  Additional information about the item. Like the color, size, code.
• tag2: string
  Additional information about the item. Like the color, size, code.
• tag3: string
  Additional information about the item. Like the color, size, code.
• tag4: string
  Additional information about the item. Like the color, size, code.
• volume: volume
  The gross volume of the item.
• volumePerShipUnit: volumePerShipUnit
  The volume per order base content line to handle shipping a multiple count number of ship units.
• weight: weight
  The gross weight of the item.
• weightPerShipUnit: weightPerShipUnit
  The weight per ship unit order base content line to handle shipping a multiple count number of ship units.

{
    "properties":{
        "sequenceNo":{
            "description":"The unique sequence within the ship unit to define the individual line items.",
            "type":"number",
            "format":"int64"
        },
        "packagedItemGid":{
            "description":"The packaged item GID defining the content line for the ship unit.",
            "type":"string"
        },
        "initialItemGid":{
            "description":"The initial packaged item GID, this value can be used to handle the original packaged item order and the substituted and item to be processed in the packaged item GID field.",
            "type":"string"
        },
        "tag1":{
            "description":"Additional information about the item. Like the color, size, code.",
            "type":"string"
        },
        "tag2":{
            "description":"Additional information about the item. Like the color, size, code.",
            "type":"string"
        },
        "tag3":{
            "description":"Additional information about the item. Like the color, size, code.",
            "type":"string"
        },
        "tag4":{
            "description":"Additional information about the item. Like the color, size, code.",
            "type":"string"
        },
        "weight":{
            "description":"The gross weight of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The gross volume of the item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "declaredValue":{
            "description":"The declared value, commercial value of the ship unit line contents for sale of goods.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "packagedCount":{
            "description":"The number of packages in this order release ship unit line for one ship unit. Its ship unit may represent more than one same ship units. E.g., for 20 ship units that contains 4 cases of 24 cans of cocoa, each order release ship unit line row will have an item GID: cocoa, item count 4x24, item package specification: case-of-24-cans, item package count: 4. The ship unit count will be 20.",
            "type":"number",
            "format":"int64"
        },
        "weightPerShipUnit":{
            "description":"The weight per ship unit order base content line to handle shipping a multiple count number of ship units.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "countPerShipUnit":{
            "description":"The packaged item count per ship unit order base content line count to handle shipping a multiple count number of ship units.",
            "type":"number",
            "format":"int64"
        },
        "volumePerShipUnit":{
            "description":"The volume per order base content line to handle shipping a multiple count number of ship units.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "packagingUnitGid":{
            "description":"The packaging unit identifier for any inner packaging associated to the ship unit such as carton configuration.",
            "type":"string"
        },
        "packagingUnitCount":{
            "description":"The packaging unit count for the inner pack.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.contents.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.contents.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.contents.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "attributes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/orderBases.shipUnits.contents.attributes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributes

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.contents.attributes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

The declared value, commercial value of the ship unit line contents for sale of goods.

Match All

Show Source

• object currencyType

{
    "description":"The declared value, commercial value of the ship unit line contents for sale of goods.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : involvedParties

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.contents.involvedParties"
            }
        },
        "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 : refnums

Type: object

Show Source

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

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

Nested Schema : remarks

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/orderBases.shipUnits.contents.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : volume

The gross volume of the item.

Match All

Show Source

• object amountType

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

Nested Schema : volumePerShipUnit

The volume per order base content line to handle shipping a multiple count number of ship units.

Match All

Show Source

• object amountType

{
    "description":"The volume per order base content line to handle shipping a multiple count number of ship units.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The gross weight of the item.

Match All

Show Source

• object amountType

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

Nested Schema : weightPerShipUnit

The weight per ship unit order base content line to handle shipping a multiple count number of ship units.

Match All

Show Source

• object amountType

{
    "description":"The weight per ship unit order base content line to handle shipping a multiple count number of ship units.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.contents.attributes

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

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 : orderBases.shipUnits.contents.attributes

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• itemFeatureQualGid: string
  The item feature qualifier GID defining what type of feature this value is associated with.
• itemFeatureValue: string
  The item feature value for the order base line. This allows for future structural definition of an item such as size and color.
• links: array links
  Read Only: true

{
    "properties":{
        "itemFeatureQualGid":{
            "description":"The item feature qualifier GID defining what type of feature this value is associated with.",
            "type":"string"
        },
        "itemFeatureValue":{
            "description":"The item feature value for the order base line. This allows for future structural definition of an item such as size and color.",
            "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
}

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

Type: array

Show Source

• Array of: object orderBases.shipUnits.contents.involvedParties

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

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 : orderBases.shipUnits.contents.involvedParties

Type: object

Show Source

• comMethodGid: string
  The communication method ID for the involved party.
• domainName: string
  Database domain where this data is stored.
• involvedPartyContactGid: string
  The contact GID for the involved party.
• involvedPartyQualGid: string
  The qualifier GID for the involved party.
• links: array links
  Read Only: true

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The qualifier GID for the involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The contact GID for the involved party.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The communication method ID for the involved party.",
            "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
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.contents.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderBases.shipUnits.contents.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 : orderBases.shipUnits.contents.refnums

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• obSuContentRefnumQualGid: string
  The reference number qualifier GID defining the reference code.
• obSuContentRefnumValue: string
  The text associated to the reference code.

{
    "properties":{
        "obSuContentRefnumQualGid":{
            "description":"The reference number qualifier GID defining the reference code.",
            "type":"string"
        },
        "obSuContentRefnumValue":{
            "description":"The text associated to the reference code.",
            "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
}

Nested Schema : items

Type: array

Show Source

• Array of: object orderBases.shipUnits.contents.remarks

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

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 : orderBases.shipUnits.contents.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualGid: string
  The remark qualifier GID defining the remark code.
• remarkSequence: number (int64)
  The remark sequence identifier used for sequential ordering.
• remarkText: string
  The text associated to the remark code.

{
    "properties":{
        "remarkSequence":{
            "description":"The remark sequence identifier used for sequential ordering.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier GID defining the remark code.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text associated to the remark code.",
            "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
}

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