Jump to

• Request
• Response

Update S Ship Units

patch

/shipments/{shipmentGid}/sShipUnits

A shipment ship unit can only be updated when provided as part of the shipment payload. It cannot be updated when targeted directly via the shipment resource URL. It can be updated when you directly use the shipment ship unit resource (sShipUnits).

Request

Path Parameters

• shipmentGid(required): string
  Resource ID

Header Parameters

• Prefer: string
  An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.

Supported Media Types

• 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/patchCollectionRequestBody"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object patchCollectionRequestBody

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

Nested Schema : patchCollectionRequestBody

Type: object

Show Source

• <Attribute Name>(required): <Attribute Name>
  Attribute that needs to be updated
• <resource ID>(required): <resource ID>
  Id of the resource whose attribute(s) needs to be updated

{
    "properties":{
        "<resource ID>":{
            "description":"Id of the resource whose attribute(s) needs to be updated",
            "oneOf":[
                {
                    "type":"integer"
                },
                {
                    "type":"number"
                },
                {
                    "type":"string"
                }
            ]
        },
        "<Attribute Name>":{
            "description":"Attribute that needs to be updated",
            "oneOf":[
                {
                    "type":"integer"
                },
                {
                    "type":"number"
                },
                {
                    "type":"string"
                },
                {
                    "type":"boolean"
                }
            ]
        }
    },
    "required":[
        "<resource ID>",
        "<Attribute Name>"
    ]
}

Nested Schema : <Attribute Name>

Attribute that needs to be updated

Match One Schema

Show Source

• integer
• number
• string
• boolean

{
    "description":"Attribute that needs to be updated",
    "oneOf":[
        {
            "type":"integer"
        },
        {
            "type":"number"
        },
        {
            "type":"string"
        },
        {
            "type":"boolean"
        }
    ]
}

Nested Schema : <resource ID>

Id of the resource whose attribute(s) needs to be updated

Match One Schema

Show Source

• integer
• number
• string

{
    "description":"Id of the resource whose attribute(s) needs to be updated",
    "oneOf":[
        {
            "type":"integer"
        },
        {
            "type":"number"
        },
        {
            "type":"string"
        }
    ]
}

Back to Top

Response

Default Response

Default Response.

Back to Top