Jump to

• Request
• Response

Create a Special Service

post

/shipmentNoSSUs/{shipmentGid}/specialServices

Request

Path Parameters

• shipmentGid(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/shipmentNoSSUs.specialServices"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices"
    }
}

Nested Schema : schema

Type: object

Show Source

• actualDistance: actualDistance
  The actual distance of the special service.
• actualDuration: actualDuration
  The actual duration of the special service.
• actualItemPackageCount: number (int64)
  The actual package count applicable to this special service.
• actualOccurTime: actualOccurTime
  The actual date and time special service occurred.
• actualShipUnitCount: number (int64)
  The actual ship unit count applicable to this special service.
• actualVolume: actualVolume
  The actual volume of the goods applicable to this special service.
• actualWeight: actualWeight
  The actual weight of the goods applicable to this special service.
• adjustmentReasonGid: string
  The reason why charge was added.
• billableIndicatorGid: string
  indicates the billable status of this special service; if values, overrides the billable status on the special service itself.
• completionState: string
  Indicates completion state of this special service.
• domainName: string
  Database domain where this data is stored.
• isPlannedDurationFixed: boolean
  If Y, prevents the system from overwriting the planned duration for the special service.
• isSystemGenerated: boolean
  Indicates if this special service was created by the system. It allows logic to determine which special services to leave in place when re-syncing the shipment special services.
• links: array links
  Read Only: true
• payableIndicatorGid: string
  Indicates the payable status of this special service; if values, overrides the payable status on the special service itself.
• plannedDuration: plannedDuration
  The planned duration of the special service.
• processAsFlowThru: boolean
  The override for record to be copied to the sell side during rating.
• refs: refs
• remarks: remarks
• secondaryCharges: secondaryCharges
• shipmentSpecialServiceSeq: number (int64)
  The sequence to keep shipment special services unique.
• specialServiceGid: string
  The special service associated with the remark.
• stopNum: number (int32)
  If the special service is for a particular stop, this indicates the stop number.

{
    "properties":{
        "shipmentSpecialServiceSeq":{
            "description":"The sequence to keep shipment special services unique.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service associated with the remark.",
            "type":"string"
        },
        "stopNum":{
            "description":"If the special service is for a particular stop, this indicates the stop number.",
            "type":"number",
            "format":"int32"
        },
        "processAsFlowThru":{
            "description":"The override for record to be copied to the sell side during rating.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"The reason why charge was added.",
            "type":"string"
        },
        "completionState":{
            "description":"Indicates completion state of this special service.",
            "type":"string"
        },
        "payableIndicatorGid":{
            "description":"Indicates the payable status of this special service; if values, overrides the payable status on the special service itself.",
            "type":"string"
        },
        "billableIndicatorGid":{
            "description":"indicates the billable status of this special service; if values, overrides the billable status on the special service itself.",
            "type":"string"
        },
        "actualOccurTime":{
            "description":"The actual date and time special service occurred.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "plannedDuration":{
            "description":"The planned duration of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPlannedDurationFixed":{
            "description":"If Y, prevents the system from overwriting the planned duration for the special service.",
            "type":"boolean"
        },
        "actualDuration":{
            "description":"The actual duration of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualDistance":{
            "description":"The actual distance of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualWeight":{
            "description":"The actual weight of the goods applicable to this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualVolume":{
            "description":"The actual volume of the goods applicable to this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualShipUnitCount":{
            "description":"The actual ship unit count applicable to this special service.",
            "type":"number",
            "format":"int64"
        },
        "actualItemPackageCount":{
            "description":"The actual package count applicable to this special service.",
            "type":"number",
            "format":"int64"
        },
        "isSystemGenerated":{
            "description":"Indicates if this special service was created by the system. It allows logic to determine which special services to leave in place when re-syncing the shipment special services.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.refs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "secondaryCharges":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.secondaryCharges"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualDistance

The actual distance of the special service.

Match All

Show Source

• object amountType

{
    "description":"The actual distance of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualDuration

The actual duration of the special service.

Match All

Show Source

• object amountType

{
    "description":"The actual duration of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualOccurTime

The actual date and time special service occurred.

Match All

Show Source

• object dateTimeType

{
    "description":"The actual date and time special service occurred.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : actualVolume

The actual volume of the goods applicable to this special service.

Match All

Show Source

• object amountType

{
    "description":"The actual volume of the goods applicable to this special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualWeight

The actual weight of the goods applicable to this special service.

Match All

Show Source

• object amountType

{
    "description":"The actual weight of the goods applicable to this special service.",
    "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 : plannedDuration

The planned duration of the special service.

Match All

Show Source

• object amountType

{
    "description":"The planned duration of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : refs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.refs"
            }
        },
        "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/shipmentNoSSUs.specialServices.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : secondaryCharges

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.secondaryCharges"
            }
        },
        "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"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "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 shipmentNoSSUs.specialServices.refs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.refs"
    }
}

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 : shipmentNoSSUs.specialServices.refs

Type: object

Show Source

• costReferenceGid: string
  The cost reference GID for the shipment special service.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipmentCostQualGid: string
  The shipment cost qualifier associated to the cost reference.

{
    "properties":{
        "costReferenceGid":{
            "description":"The cost reference GID for the shipment special service.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"The shipment cost qualifier associated to the cost reference.",
            "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 shipmentNoSSUs.specialServices.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.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 : shipmentNoSSUs.specialServices.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, or type.
• remarkSequence: number (int64)
  The one-up number to make the remark unique.
• remarkText: string
  The remark text itself.

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up number to make the remark unique.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, or type.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text itself.",
            "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 shipmentNoSSUs.specialServices.secondaryCharges

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.secondaryCharges"
    }
}

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 : shipmentNoSSUs.specialServices.secondaryCharges

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• secondaryChargeShipmentGid: string
  The secondary charge shipment identifier that contains the cost elements and information for the charges.

{
    "properties":{
        "secondaryChargeShipmentGid":{
            "description":"The secondary charge shipment identifier that contains the cost elements and information for the charges.",
            "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
}

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

Root Schema : schema

Type: object

Show Source

• actualDistance: actualDistance
  The actual distance of the special service.
• actualDuration: actualDuration
  The actual duration of the special service.
• actualItemPackageCount: number (int64)
  The actual package count applicable to this special service.
• actualOccurTime: actualOccurTime
  The actual date and time special service occurred.
• actualShipUnitCount: number (int64)
  The actual ship unit count applicable to this special service.
• actualVolume: actualVolume
  The actual volume of the goods applicable to this special service.
• actualWeight: actualWeight
  The actual weight of the goods applicable to this special service.
• adjustmentReasonGid: string
  The reason why charge was added.
• billableIndicatorGid: string
  indicates the billable status of this special service; if values, overrides the billable status on the special service itself.
• completionState: string
  Indicates completion state of this special service.
• domainName: string
  Database domain where this data is stored.
• isPlannedDurationFixed: boolean
  If Y, prevents the system from overwriting the planned duration for the special service.
• isSystemGenerated: boolean
  Indicates if this special service was created by the system. It allows logic to determine which special services to leave in place when re-syncing the shipment special services.
• links: array links
  Read Only: true
• payableIndicatorGid: string
  Indicates the payable status of this special service; if values, overrides the payable status on the special service itself.
• plannedDuration: plannedDuration
  The planned duration of the special service.
• processAsFlowThru: boolean
  The override for record to be copied to the sell side during rating.
• refs: refs
• remarks: remarks
• secondaryCharges: secondaryCharges
• shipmentSpecialServiceSeq: number (int64)
  The sequence to keep shipment special services unique.
• specialServiceGid: string
  The special service associated with the remark.
• stopNum: number (int32)
  If the special service is for a particular stop, this indicates the stop number.

{
    "properties":{
        "shipmentSpecialServiceSeq":{
            "description":"The sequence to keep shipment special services unique.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service associated with the remark.",
            "type":"string"
        },
        "stopNum":{
            "description":"If the special service is for a particular stop, this indicates the stop number.",
            "type":"number",
            "format":"int32"
        },
        "processAsFlowThru":{
            "description":"The override for record to be copied to the sell side during rating.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"The reason why charge was added.",
            "type":"string"
        },
        "completionState":{
            "description":"Indicates completion state of this special service.",
            "type":"string"
        },
        "payableIndicatorGid":{
            "description":"Indicates the payable status of this special service; if values, overrides the payable status on the special service itself.",
            "type":"string"
        },
        "billableIndicatorGid":{
            "description":"indicates the billable status of this special service; if values, overrides the billable status on the special service itself.",
            "type":"string"
        },
        "actualOccurTime":{
            "description":"The actual date and time special service occurred.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "plannedDuration":{
            "description":"The planned duration of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPlannedDurationFixed":{
            "description":"If Y, prevents the system from overwriting the planned duration for the special service.",
            "type":"boolean"
        },
        "actualDuration":{
            "description":"The actual duration of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualDistance":{
            "description":"The actual distance of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualWeight":{
            "description":"The actual weight of the goods applicable to this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualVolume":{
            "description":"The actual volume of the goods applicable to this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualShipUnitCount":{
            "description":"The actual ship unit count applicable to this special service.",
            "type":"number",
            "format":"int64"
        },
        "actualItemPackageCount":{
            "description":"The actual package count applicable to this special service.",
            "type":"number",
            "format":"int64"
        },
        "isSystemGenerated":{
            "description":"Indicates if this special service was created by the system. It allows logic to determine which special services to leave in place when re-syncing the shipment special services.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.refs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "secondaryCharges":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.secondaryCharges"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualDistance

The actual distance of the special service.

Match All

Show Source

• object amountType

{
    "description":"The actual distance of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualDuration

The actual duration of the special service.

Match All

Show Source

• object amountType

{
    "description":"The actual duration of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualOccurTime

The actual date and time special service occurred.

Match All

Show Source

• object dateTimeType

{
    "description":"The actual date and time special service occurred.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : actualVolume

The actual volume of the goods applicable to this special service.

Match All

Show Source

• object amountType

{
    "description":"The actual volume of the goods applicable to this special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualWeight

The actual weight of the goods applicable to this special service.

Match All

Show Source

• object amountType

{
    "description":"The actual weight of the goods applicable to this special service.",
    "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 : plannedDuration

The planned duration of the special service.

Match All

Show Source

• object amountType

{
    "description":"The planned duration of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : refs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.refs"
            }
        },
        "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/shipmentNoSSUs.specialServices.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : secondaryCharges

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.secondaryCharges"
            }
        },
        "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"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "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 shipmentNoSSUs.specialServices.refs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.refs"
    }
}

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 : shipmentNoSSUs.specialServices.refs

Type: object

Show Source

• costReferenceGid: string
  The cost reference GID for the shipment special service.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipmentCostQualGid: string
  The shipment cost qualifier associated to the cost reference.

{
    "properties":{
        "costReferenceGid":{
            "description":"The cost reference GID for the shipment special service.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"The shipment cost qualifier associated to the cost reference.",
            "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 shipmentNoSSUs.specialServices.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.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 : shipmentNoSSUs.specialServices.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, or type.
• remarkSequence: number (int64)
  The one-up number to make the remark unique.
• remarkText: string
  The remark text itself.

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up number to make the remark unique.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, or type.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text itself.",
            "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 shipmentNoSSUs.specialServices.secondaryCharges

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.secondaryCharges"
    }
}

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 : shipmentNoSSUs.specialServices.secondaryCharges

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• secondaryChargeShipmentGid: string
  The secondary charge shipment identifier that contains the cost elements and information for the charges.

{
    "properties":{
        "secondaryChargeShipmentGid":{
            "description":"The secondary charge shipment identifier that contains the cost elements and information for the charges.",
            "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

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

• actualDistance: actualDistance
  The actual distance of the special service.
• actualDuration: actualDuration
  The actual duration of the special service.
• actualItemPackageCount: number (int64)
  The actual package count applicable to this special service.
• actualOccurTime: actualOccurTime
  The actual date and time special service occurred.
• actualShipUnitCount: number (int64)
  The actual ship unit count applicable to this special service.
• actualVolume: actualVolume
  The actual volume of the goods applicable to this special service.
• actualWeight: actualWeight
  The actual weight of the goods applicable to this special service.
• adjustmentReasonGid: string
  The reason why charge was added.
• billableIndicatorGid: string
  indicates the billable status of this special service; if values, overrides the billable status on the special service itself.
• completionState: string
  Indicates completion state of this special service.
• domainName: string
  Database domain where this data is stored.
• isPlannedDurationFixed: boolean
  If Y, prevents the system from overwriting the planned duration for the special service.
• isSystemGenerated: boolean
  Indicates if this special service was created by the system. It allows logic to determine which special services to leave in place when re-syncing the shipment special services.
• links: array links
  Read Only: true
• payableIndicatorGid: string
  Indicates the payable status of this special service; if values, overrides the payable status on the special service itself.
• plannedDuration: plannedDuration
  The planned duration of the special service.
• processAsFlowThru: boolean
  The override for record to be copied to the sell side during rating.
• refs: refs
• remarks: remarks
• secondaryCharges: secondaryCharges
• shipmentSpecialServiceSeq: number (int64)
  The sequence to keep shipment special services unique.
• specialServiceGid: string
  The special service associated with the remark.
• stopNum: number (int32)
  If the special service is for a particular stop, this indicates the stop number.

{
    "properties":{
        "shipmentSpecialServiceSeq":{
            "description":"The sequence to keep shipment special services unique.",
            "type":"number",
            "format":"int64"
        },
        "specialServiceGid":{
            "description":"The special service associated with the remark.",
            "type":"string"
        },
        "stopNum":{
            "description":"If the special service is for a particular stop, this indicates the stop number.",
            "type":"number",
            "format":"int32"
        },
        "processAsFlowThru":{
            "description":"The override for record to be copied to the sell side during rating.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"The reason why charge was added.",
            "type":"string"
        },
        "completionState":{
            "description":"Indicates completion state of this special service.",
            "type":"string"
        },
        "payableIndicatorGid":{
            "description":"Indicates the payable status of this special service; if values, overrides the payable status on the special service itself.",
            "type":"string"
        },
        "billableIndicatorGid":{
            "description":"indicates the billable status of this special service; if values, overrides the billable status on the special service itself.",
            "type":"string"
        },
        "actualOccurTime":{
            "description":"The actual date and time special service occurred.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "plannedDuration":{
            "description":"The planned duration of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "isPlannedDurationFixed":{
            "description":"If Y, prevents the system from overwriting the planned duration for the special service.",
            "type":"boolean"
        },
        "actualDuration":{
            "description":"The actual duration of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualDistance":{
            "description":"The actual distance of the special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualWeight":{
            "description":"The actual weight of the goods applicable to this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualVolume":{
            "description":"The actual volume of the goods applicable to this special service.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "actualShipUnitCount":{
            "description":"The actual ship unit count applicable to this special service.",
            "type":"number",
            "format":"int64"
        },
        "actualItemPackageCount":{
            "description":"The actual package count applicable to this special service.",
            "type":"number",
            "format":"int64"
        },
        "isSystemGenerated":{
            "description":"Indicates if this special service was created by the system. It allows logic to determine which special services to leave in place when re-syncing the shipment special services.",
            "type":"boolean"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.refs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "secondaryCharges":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.secondaryCharges"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : actualDistance

The actual distance of the special service.

Match All

Show Source

• object amountType

{
    "description":"The actual distance of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualDuration

The actual duration of the special service.

Match All

Show Source

• object amountType

{
    "description":"The actual duration of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualOccurTime

The actual date and time special service occurred.

Match All

Show Source

• object dateTimeType

{
    "description":"The actual date and time special service occurred.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : actualVolume

The actual volume of the goods applicable to this special service.

Match All

Show Source

• object amountType

{
    "description":"The actual volume of the goods applicable to this special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : actualWeight

The actual weight of the goods applicable to this special service.

Match All

Show Source

• object amountType

{
    "description":"The actual weight of the goods applicable to this special service.",
    "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 : plannedDuration

The planned duration of the special service.

Match All

Show Source

• object amountType

{
    "description":"The planned duration of the special service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : refs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.refs"
            }
        },
        "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/shipmentNoSSUs.specialServices.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : secondaryCharges

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.secondaryCharges"
            }
        },
        "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"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "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 shipmentNoSSUs.specialServices.refs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.refs"
    }
}

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 : shipmentNoSSUs.specialServices.refs

Type: object

Show Source

• costReferenceGid: string
  The cost reference GID for the shipment special service.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipmentCostQualGid: string
  The shipment cost qualifier associated to the cost reference.

{
    "properties":{
        "costReferenceGid":{
            "description":"The cost reference GID for the shipment special service.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"The shipment cost qualifier associated to the cost reference.",
            "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 shipmentNoSSUs.specialServices.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.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 : shipmentNoSSUs.specialServices.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, or type.
• remarkSequence: number (int64)
  The one-up number to make the remark unique.
• remarkText: string
  The remark text itself.

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up number to make the remark unique.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, or type.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark text itself.",
            "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 shipmentNoSSUs.specialServices.secondaryCharges

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipmentNoSSUs.specialServices.secondaryCharges"
    }
}

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 : shipmentNoSSUs.specialServices.secondaryCharges

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• secondaryChargeShipmentGid: string
  The secondary charge shipment identifier that contains the cost elements and information for the charges.

{
    "properties":{
        "secondaryChargeShipmentGid":{
            "description":"The secondary charge shipment identifier that contains the cost elements and information for the charges.",
            "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