Jump to

• Request
• Response

Get Accessorials

get

/shipments/{shipmentGid}/accessorials

Request

Path Parameters

• shipmentGid(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/shipments.accessorials"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.accessorials

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.accessorials"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : shipments.accessorials

Type: object

Show Source

• accessorialCodeGid: string
  The XID for the shipment.
• adjustmentReasonGid: string
  The reason why the accessorial was added.
• costRefs: costRefs
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• processAsFlowThru: boolean
  The override for record to be copied to the sell side during rating.
• remarks: remarks

{
    "properties":{
        "accessorialCodeGid":{
            "description":"The XID for the shipment.",
            "type":"string"
        },
        "processAsFlowThru":{
            "description":"The override for record to be copied to the sell side during rating.",
            "type":"boolean"
        },
        "adjustmentReasonGid":{
            "description":"The reason why the accessorial was added.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "costRefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.accessorials.costRefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/shipments.accessorials.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : costRefs

Type: object

Show Source

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

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/shipments.accessorials.costRefs"
            }
        },
        "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 : remarks

Type: object

Show Source

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

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

Nested Schema : items

Type: array

Show Source

• Array of: object shipments.accessorials.costRefs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.accessorials.costRefs"
    }
}

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.accessorials.costRefs

Type: object

Show Source

• costReferenceGid: string
  The cost reference GID.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• shipmentCostQualGid: string
  The shipment cost qualifier GID that defines the type of cost.

{
    "properties":{
        "costReferenceGid":{
            "description":"The cost reference GID.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"The shipment cost qualifier GID that defines the type of cost.",
            "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 : items

Type: array

Show Source

• Array of: object shipments.accessorials.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/shipments.accessorials.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 : shipments.accessorials.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, which identifies the type of remark this is.
• remarkSequence: number (int64)
  The one-up sequence for the remark, to create a unique identifier.
• remarkText: string
  The remark itself.

{
    "properties":{
        "remarkSequence":{
            "description":"The one-up sequence for the remark, to create a unique identifier.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"The remark qualifier, which identifies the type of remark this is.",
            "type":"string"
        },
        "remarkText":{
            "description":"The remark 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
}

Back to Top