Jump to

• Request
• Response

Get a Detail

get

/shipments/{shipmentGid}/stops/{stopNum}/details/{sShipUnitGid}

Request

Path Parameters

• sShipUnitGid(required): string
  Resource ID
• shipmentGid(required): string
  Resource ID
• stopNum(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

• activity: string
  The activity performed at the stop. For example: pickup, delivery, etc.
• activityTime: activityTime
  The time spent performing the activity at the shipment stop.
• domainName: string
  Date and time of the most recent data update.
• involvedParties: involvedParties
• isPermanent: boolean
  A Y/N indicator to define the stop as permanent. Any subsequent actions and modifications to the shipment will retain this record.
• links: array links
  Read Only: true
• shipUnitDwellTime: shipUnitDwellTime
  The ship unit dwell time at the stop location as entered.
• sShipUnitGid: string
  A GID to define the shipment ship unit.

{
    "properties":{
        "sShipUnitGid":{
            "description":"A GID to define the shipment ship unit.",
            "type":"string"
        },
        "activity":{
            "description":"The activity performed at the stop. For example: pickup, delivery, etc.",
            "type":"string"
        },
        "activityTime":{
            "description":"The time spent performing the activity at the shipment stop.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPermanent":{
            "description":"A Y/N indicator to define the stop as permanent. Any subsequent actions and modifications to the shipment will retain this record.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Date and time of the most recent data update.",
            "type":"string"
        },
        "shipUnitDwellTime":{
            "description":"The ship unit dwell time at the stop location as entered.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.stops.details.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : activityTime

The time spent performing the activity at the shipment stop.

Match All

Show Source

• object amountType

{
    "description":"The time spent performing the activity at the shipment stop.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : involvedParties

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.stops.details.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 : shipUnitDwellTime

The ship unit dwell time at the stop location as entered.

Match All

Show Source

• object amountType

{
    "description":"The ship unit dwell time at the stop location as entered.",
    "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 : items

Type: array

Show Source

• Array of: object shipments.stops.details.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.stops.details.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 : shipments.stops.details.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 ID for the involved party.
• involvedPartyQualGid: string
  The qualifier ID for the involved party.
• links: array links
  Read Only: true

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

Type: object

Show Source

• href: string
• rel: string

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

Back to Top