Jump to

• Request
• Response

Get Substitutes

get

/locations/{locationGid}/substitutes

Request

Path Parameters

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

Nested Schema : items

Type: array

Show Source

• Array of: object locations.substitutes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/locations.substitutes"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : locations.substitutes

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• substituteLocationGid: string
  The GID for the substitute location. Use this field to define ONE alternate location from which an order is picked up for transportation purposes. For example, for any ship unit or line item on an order, you can record a Source Location and Destination Location that would typically be used to plan a shipment. However, if you record a Substitute Location for any location that is used as a Source Location on an order, Oracle Transportation Management automatically uses the Substitute Location and populates it on the order release. Oracle Transportation Management also uses the Substitute Location on the order release as the source location when building a shipment; however you can override this location on the order base and order release.

{
    "properties":{
        "substituteLocationGid":{
            "description":"The GID for the substitute location.  Use this field to define ONE alternate location from which an order is picked up for transportation purposes. For example, for any ship unit or line item on an order, you can record a Source Location and Destination Location that would typically be used to plan a shipment. However, if you record a Substitute Location for any location that is used as a Source Location on an order, Oracle Transportation Management automatically uses the Substitute Location and populates it on the order release. Oracle Transportation Management also uses the Substitute Location on the order release as the source location when building a shipment; however you can override this location on the order base and order release.",
            "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