Jump to

• Request
• Response

Get Details for an Allocation

get

/services/private/Alloc/allocDetail

This service allows user to retrieve Allocation information for a selected allocation number.

Request

Query Parameters

• allocNumber(required): integer(int64)
  Allocation Number

Header Parameters

• Accept-Language:
  Accept-Language header

  Example:

  en-US

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Allocation Details

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RestAllocRecRDO

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

Nested Schema : RestAllocRecRDO

Type: object

Show Source

• allocDesc: string
• allocDetail: array allocDetail
• allocMethod: string
• allocNo: number
• attributeNames: array attributeNames
• attributes: array attributes
• closeDate: string (date-time)
• doc: string
• docType: string
• hyperMediaContent: object hyperMediaContent
• item: string
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• orderNo: number
• orderType: string
• originInd: string
• poType: string
• releaseDate: string (date-time)
• status: string
• wh: number

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "docType":{
            "type":"string"
        },
        "allocDetail":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestAllocDetailRecRDO"
            }
        },
        "doc":{
            "type":"string"
        },
        "originInd":{
            "type":"string"
        },
        "allocNo":{
            "type":"number"
        },
        "wh":{
            "type":"number"
        },
        "allocMethod":{
            "type":"string"
        },
        "allocDesc":{
            "type":"string"
        },
        "poType":{
            "type":"string"
        },
        "item":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "orderNo":{
            "type":"number"
        },
        "orderType":{
            "type":"string"
        },
        "releaseDate":{
            "type":"string",
            "format":"date-time"
        },
        "closeDate":{
            "type":"string",
            "format":"date-time"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : allocDetail

Type: array

Show Source

• Array of: object RestAllocDetailRecRDO

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

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : RestAllocDetailRecRDO

Type: object

Show Source

• attributeNames: array attributeNames
• attributes: array attributes
• hyperMediaContent: object hyperMediaContent
• inStoreDate: string (date-time)
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• nonScaleInd: string
• poRcvdQty: number
• qtyAllocated: number
• qtyCancelled: number
• qtyDistro: number
• qtyPrescaled: number
• qtyReceived: number
• qtyReconciled: number
• qtySelected: number
• qtyTransferred: number
• rushFlag: string
• toLoc: number
• toLocType: string
• wfOrderNo: number

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "qtyTransferred":{
            "type":"number"
        },
        "rushFlag":{
            "type":"string"
        },
        "wfOrderNo":{
            "type":"number"
        },
        "inStoreDate":{
            "type":"string",
            "format":"date-time"
        },
        "qtyAllocated":{
            "type":"number"
        },
        "nonScaleInd":{
            "type":"string"
        },
        "toLoc":{
            "type":"number"
        },
        "qtyPrescaled":{
            "type":"number"
        },
        "toLocType":{
            "type":"string"
        },
        "qtyDistro":{
            "type":"number"
        },
        "qtySelected":{
            "type":"number"
        },
        "qtyReceived":{
            "type":"number"
        },
        "qtyCancelled":{
            "type":"number"
        },
        "qtyReconciled":{
            "type":"number"
        },
        "poRcvdQty":{
            "type":"number"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : items

Type: object

Nested Schema : Link

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

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

Nested Schema : items

Type: object

Back to Top