Jump to

• Request
• Response
• Examples

Create list of replenishment requests

post

/fscmRestApi/resources/11.13.18.05/vmiReplenishmentRequests

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DeliveryDate: string (date)
  Date when the item is expected to be delivered.
• InventoryItemId: integer (int64)
  Default Value: -2

  Value that uniquely identifies the inventory item in the replenishment request.
• ItemNumber: string
  Number that identifies the item.
• Notes: string
  Maximum Length: 400

  Note created by the person who submitted the replenishment request.
• OrganizationCode: string
  Abbreviation that identifies the organization that receives the item.
• OrganizationId: integer (int64)
  Default Value: -2

  Value that uniquely identifies the organization in the replenishment request. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.
• ProcurementBU: string
  Name of the business unit. The application assigns the supplier to this business unit.
• ProcurementBUId: integer
  Value that uniquely identifies the business unit that manages and owns the purchasing document.
• ReplenishmentLifeCycle: array Replenishment Life Cycle
  Title: Replenishment Life Cycle

  The Replenishment Life Cycle resource gets the life cycle states for a replenishment request.
• ReplenishmentQuantity: number
  Quantity of the replenishment requests for the inventory item.
• ReplenishmentRequestErrors: array Replenishment Request Errors
  Title: Replenishment Request Errors

  The Replenishment Request Errors resource manages the errors received when a request is in the Failed status.
• Subinventory: string
  Maximum Length: 10

  Name of the subinventory that receives the item.
• SupplierId: integer (int64)
  Default Value: -2

  Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.
• SupplierName: string
  Name of the supplier who ships the item.
• SupplierSiteId: integer (int64)
  Default Value: -2

  Value that uniquely identifies the supplier site that manages this item.
• SupplierSiteName: string
  Maximum Length: 255

  Name of the supplier site that ships the item.

{
    "type":"object",
    "properties":{
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that manages and owns the purchasing document.",
            "nullable":true
        },
        "ProcurementBU":{
            "type":"string",
            "description":"Name of the business unit. The application assigns the supplier to this business unit.",
            "nullable":true
        },
        "ReplenishmentQuantity":{
            "type":"number",
            "description":"Quantity of the replenishment requests for the inventory item.",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item in the replenishment request.",
            "format":"int64",
            "nullable":false,
            "default":"-2",
            "x-hints":{
                "precision":"18"
            }
        },
        "ReplenishmentRequestErrors":{
            "title":"Replenishment Request Errors",
            "type":"array",
            "description":"The Replenishment Request Errors resource manages the errors received when a request is in the Failed status.",
            "items":{
                "$ref":"#/components/schemas/vmiReplenishmentRequests-ReplenishmentRequestErrors-item-post-request"
            }
        },
        "SupplierSiteName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier site that ships the item.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization in the replenishment request. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.",
            "format":"int64",
            "nullable":false,
            "default":"-2",
            "x-hints":{
                "precision":"18"
            }
        },
        "DeliveryDate":{
            "type":"string",
            "description":"Date when the item is expected to be delivered.",
            "format":"date",
            "nullable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.",
            "format":"int64",
            "nullable":false,
            "default":"-2",
            "x-hints":{
                "precision":"18"
            }
        },
        "ItemNumber":{
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true
        },
        "SupplierName":{
            "type":"string",
            "description":"Name of the supplier who ships the item.",
            "nullable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site that manages this item.",
            "format":"int64",
            "nullable":false,
            "default":"-2",
            "x-hints":{
                "precision":"18"
            }
        },
        "Subinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory that receives the item.",
            "nullable":true
        },
        "ReplenishmentLifeCycle":{
            "title":"Replenishment Life Cycle",
            "type":"array",
            "description":"The Replenishment Life Cycle resource gets the life cycle states for a replenishment request.",
            "items":{
                "$ref":"#/components/schemas/vmiReplenishmentRequests-ReplenishmentLifeCycle-item-post-request"
            }
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization that receives the item.",
            "nullable":true
        },
        "Notes":{
            "maxLength":"400",
            "type":"string",
            "description":"Note created by the person who submitted the replenishment request.",
            "nullable":true
        }
    }
}

Nested Schema : Replenishment Life Cycle

Type: array

Title: Replenishment Life Cycle

The Replenishment Life Cycle resource gets the life cycle states for a replenishment request.

Show Source

• Array of: object vmiReplenishmentRequests-ReplenishmentLifeCycle-item-post-request

{
    "title":"Replenishment Life Cycle",
    "type":"array",
    "description":"The Replenishment Life Cycle resource gets the life cycle states for a replenishment request.",
    "items":{
        "$ref":"#/components/schemas/vmiReplenishmentRequests-ReplenishmentLifeCycle-item-post-request"
    }
}

Nested Schema : Replenishment Request Errors

Type: array

Title: Replenishment Request Errors

The Replenishment Request Errors resource manages the errors received when a request is in the Failed status.

Show Source

• Array of: object vmiReplenishmentRequests-ReplenishmentRequestErrors-item-post-request

{
    "title":"Replenishment Request Errors",
    "type":"array",
    "description":"The Replenishment Request Errors resource manages the errors received when a request is in the Failed status.",
    "items":{
        "$ref":"#/components/schemas/vmiReplenishmentRequests-ReplenishmentRequestErrors-item-post-request"
    }
}

Nested Schema : vmiReplenishmentRequests-ReplenishmentLifeCycle-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : vmiReplenishmentRequests-ReplenishmentRequestErrors-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : vmiReplenishmentRequests-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the replenishment request.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the replenishment request.
• DelivertoLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the location where the item is delivered. This attribute isn't available to suppliers.
• DelivertoLocationName: string
  Read Only: true

  Maximum Length: 240

  Name of the location where the item is delivered. This attribute isn't available to suppliers.
• DeliveryDate: string (date)
  Date when the item is expected to be delivered.
• InventoryItemId: integer (int64)
  Default Value: -2

  Value that uniquely identifies the inventory item in the replenishment request.
• InvoiceNumber: string
  Read Only: true

  Number that identifies the invoice.
• ItemCategory: string
  Read Only: true

  Maximum Length: 255

  Category that the application assigns to the item.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the item.
• ItemNumber: string
  Number that identifies the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the replenishment request.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Login of the user who most recently updated the replenishment request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Notes: string
  Maximum Length: 400

  Note created by the person who submitted the replenishment request.
• OrganizationCode: string
  Abbreviation that identifies the organization that receives the item.
• OrganizationId: integer (int64)
  Default Value: -2

  Value that uniquely identifies the organization in the replenishment request. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.
• OrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization that receives the item.
• PaymentNumber: string
  Read Only: true

  Number that identifies the payment.
• ProcessId: integer (int64)
  Read Only: true

  Value that uniquely identifies the process of the scheduled job.
• ProcurementBU: string
  Name of the business unit. The application assigns the supplier to this business unit.
• ProcurementBUId: integer
  Value that uniquely identifies the business unit that manages and owns the purchasing document.
• PurchaseOrderNumber: string
  Read Only: true

  Number that identifies the purchase order.
• ReceiptNumber: string
  Read Only: true

  Number that identifies the receipt.
• ReplenishmentLifeCycle: array Replenishment Life Cycle
  Title: Replenishment Life Cycle

  The Replenishment Life Cycle resource gets the life cycle states for a replenishment request.
• ReplenishmentQuantity: number
  Quantity of the replenishment requests for the inventory item.
• ReplenishmentRequestErrors: array Replenishment Request Errors
  Title: Replenishment Request Errors

  The Replenishment Request Errors resource manages the errors received when a request is in the Failed status.
• ReplenishmentRequestId: integer (int64)
  Read Only: true

  Value that uniquely identifies the replenishment request.
• ReplenishmentRequestNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the replenishment request.
• RequisitionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the requisition. This attribute isn't available to suppliers.
• RequisitionNumber: string
  Read Only: true

  Maximum Length: 64

  Number that identifies the requisition. This attribute isn't available to suppliers.
• RequisitionRequesterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the user requesting the requisition.
• RequisitionRequesterName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the user requesting the requisition.
• ShipmentNumber: string
  Read Only: true

  Number that identifies the shipment.
• ShipToLocation: string
  Read Only: true

  Name of the ship-to location.
• Status: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  State of the of the replenishment request. Values can be Submitted, In Process, Requested, Pending Approval, Closed, Failed, Canceled, or Rejected.
• StatusCode: string
  Title: Lookup Code

  Read Only: true

  Maximum Length: 30

  Value that identifies the state of the replenishment item. A list of accepted values is defined in the lookup type ORA_VCS_VMI_ITEM_STATUS.
• Subinventory: string
  Maximum Length: 10

  Name of the subinventory that receives the item.
• SubinventoryDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 50

  Description of the subinventory.
• SubmittedDate: string (date)
  Read Only: true

  Date when the replenishment request was submitted.
• SupplierId: integer (int64)
  Default Value: -2

  Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.
• SupplierItemId: integer
  Read Only: true

  Value that uniquely identifies the supplier item in the replenishment request.
• SupplierItemName: string
  Read Only: true

  Maximum Length: 255

  Name of the item given by the supplier.
• SupplierName: string
  Name of the supplier who ships the item.
• SupplierNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the supplier who ships the item.
• SupplierSiteId: integer (int64)
  Default Value: -2

  Value that uniquely identifies the supplier site that manages this item.
• SupplierSiteName: string
  Maximum Length: 255

  Name of the supplier site that ships the item.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure for the item.
• UOMCode: string
  Title: Primary UOM

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the item.
• VmiItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the vendor-managed inventory item.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the replenishment request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier item in the replenishment request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentNumber":{
            "type":"string",
            "description":"Number that identifies the shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReplenishmentRequestErrors":{
            "title":"Replenishment Request Errors",
            "type":"array",
            "description":"The Replenishment Request Errors resource manages the errors received when a request is in the Failed status.",
            "items":{
                "$ref":"#/components/schemas/vmiReplenishmentRequests-ReplenishmentRequestErrors-item-response"
            }
        },
        "DeliveryDate":{
            "type":"string",
            "description":"Date when the item is expected to be delivered.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Lookup Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the state of the replenishment item. A list of accepted values is defined in the lookup type ORA_VCS_VMI_ITEM_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisition. This attribute isn't available to suppliers.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemCategory":{
            "maxLength":"255",
            "type":"string",
            "description":"Category that the application assigns to the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InvoiceNumber":{
            "type":"string",
            "description":"Number that identifies the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"Primary UOM",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelivertoLocationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the location where the item is delivered. This attribute isn't available to suppliers.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "type":"string",
            "description":"Number that identifies the receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"State of the of the replenishment request. Values can be Submitted, In Process, Requested, Pending Approval, Closed, Failed, Canceled, or Rejected.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Login of the user who most recently updated the replenishment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that manages and owns the purchasing document.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBU":{
            "type":"string",
            "description":"Name of the business unit. The application assigns the supplier to this business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the replenishment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReplenishmentQuantity":{
            "type":"number",
            "description":"Quantity of the replenishment requests for the inventory item.",
            "nullable":true,
            "x-queryable":true
        },
        "ReplenishmentRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replenishment request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for the item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item in the replenishment request.",
            "format":"int64",
            "nullable":false,
            "default":"-2",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipToLocation":{
            "type":"string",
            "description":"Name of the ship-to location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who ships the item. It's a primary key that the application generates when it creates the supplier.",
            "format":"int64",
            "nullable":false,
            "default":"-2",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReplenishmentLifeCycle":{
            "title":"Replenishment Life Cycle",
            "type":"array",
            "description":"The Replenishment Life Cycle resource gets the life cycle states for a replenishment request.",
            "items":{
                "$ref":"#/components/schemas/vmiReplenishmentRequests-ReplenishmentLifeCycle-item-response"
            }
        },
        "DelivertoLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the item is delivered. This attribute isn't available to suppliers.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentNumber":{
            "type":"string",
            "description":"Number that identifies the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the organization that receives the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionRequesterName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the user requesting the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier site that ships the item.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization in the replenishment request. This organization receives the shipment. It's a primary key that the application generates when it creates an organization.",
            "format":"int64",
            "nullable":false,
            "default":"-2",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubmittedDate":{
            "type":"string",
            "description":"Date when the replenishment request was submitted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"Number that identifies the requisition. This attribute isn't available to suppliers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VmiItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the vendor-managed inventory item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ReplenishmentRequestNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the replenishment request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site that manages this item.",
            "format":"int64",
            "nullable":false,
            "default":"-2",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization that receives the item.",
            "nullable":true,
            "x-queryable":true
        },
        "Notes":{
            "maxLength":"400",
            "type":"string",
            "description":"Note created by the person who submitted the replenishment request.",
            "nullable":true,
            "x-queryable":true
        },
        "PurchaseOrderNumber":{
            "type":"string",
            "description":"Number that identifies the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionRequesterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user requesting the requisition.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SupplierNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the supplier who ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierItemName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item given by the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubinventoryDescription":{
            "title":"Description",
            "maxLength":"50",
            "type":"string",
            "description":"Description of the subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierName":{
            "type":"string",
            "description":"Name of the supplier who ships the item.",
            "nullable":true,
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory that receives the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process of the scheduled job.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the replenishment request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Replenishment Life Cycle

Type: array

Title: Replenishment Life Cycle

The Replenishment Life Cycle resource gets the life cycle states for a replenishment request.

Show Source

• Array of: object vmiReplenishmentRequests-ReplenishmentLifeCycle-item-response

{
    "title":"Replenishment Life Cycle",
    "type":"array",
    "description":"The Replenishment Life Cycle resource gets the life cycle states for a replenishment request.",
    "items":{
        "$ref":"#/components/schemas/vmiReplenishmentRequests-ReplenishmentLifeCycle-item-response"
    }
}

Nested Schema : Replenishment Request Errors

Type: array

Title: Replenishment Request Errors

The Replenishment Request Errors resource manages the errors received when a request is in the Failed status.

Show Source

• Array of: object vmiReplenishmentRequests-ReplenishmentRequestErrors-item-response

{
    "title":"Replenishment Request Errors",
    "type":"array",
    "description":"The Replenishment Request Errors resource manages the errors received when a request is in the Failed status.",
    "items":{
        "$ref":"#/components/schemas/vmiReplenishmentRequests-ReplenishmentRequestErrors-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : vmiReplenishmentRequests-ReplenishmentLifeCycle-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Quantity: number
  Read Only: true

  Quantity of the replenishment request in the replenishment life cycle state.
• ReplenishmentLifeCycleCode: string
  Read Only: true

  Maximum Length: 25

  Value that identifies the state of the replenishment item in the procurement life cycle. A list of accepted values is defined in the lookup type ORA_VCS_VMI_REPL_LIFE_CYCLE.
• ReplenishmentLifeCycleName: string
  Read Only: true

  Maximum Length: 80

  State of the replenishment request in the procurement life cycle. Values can be pending request approval, pending receipt, pending shipment, or pending delivery.

{
    "type":"object",
    "properties":{
        "Quantity":{
            "type":"number",
            "description":"Quantity of the replenishment request in the replenishment life cycle state.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReplenishmentLifeCycleName":{
            "maxLength":"80",
            "type":"string",
            "description":"State of the replenishment request in the procurement life cycle. Values can be pending request approval, pending receipt, pending shipment, or pending delivery.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReplenishmentLifeCycleCode":{
            "maxLength":"25",
            "type":"string",
            "description":"Value that identifies the state of the replenishment item in the procurement life cycle. A list of accepted values is defined in the lookup type ORA_VCS_VMI_REPL_LIFE_CYCLE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : vmiReplenishmentRequests-ReplenishmentRequestErrors-item-response

Type: object

Show Source

• ErrorCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the error message.
• ErrorDescription: string
  Read Only: true

  Maximum Length: 2000

  Description of the error message.
• ErrorId: integer (int64)
  Read Only: true

  Value that uniquely identifies the error message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ErrorDescription":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the error message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ErrorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the error message.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ErrorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the error message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

ReplenishmentLifeCycle

Operation: /fscmRestApi/resources/11.13.18.05/vmiReplenishmentRequests/{ReplenishmentRequestNumber}/child/ReplenishmentLifeCycle

Parameters:

• ReplenishmentRequestNumber: $request.path.ReplenishmentRequestNumber

The Replenishment Life Cycle resource gets the life cycle states for a replenishment request.

ReplenishmentRequestErrors

Operation: /fscmRestApi/resources/11.13.18.05/vmiReplenishmentRequests/{ReplenishmentRequestNumber}/child/ReplenishmentRequestErrors

Parameters:

• ReplenishmentRequestNumber: $request.path.ReplenishmentRequestNumber

The Replenishment Request Errors resource manages the errors received when a request is in the Failed status.

Back to Top

Examples

This example describes how to create list of replenishment requests.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/vmiReplenishmentRequests"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
 "SupplierName": "CV_SuppD05",
    "ItemNumber": "VMI-P200",
    "OrganizationCode": "VMIMFG3",
    "ReplenishmentQuantity": 10,
    "DeliveryDate": "2018-12-10",
    "Notes": "Notes to the Buyer"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "ReplenishmentRequestId": 300100176811309,
    "ReplenishmentRequestNumber": null,
    "SupplierId": -2,
    "SupplierName": "CV_SuppD05",
    "SupplierNumber": null,
    "SupplierSiteId": -2,
    "SupplierSiteName": null,
    "ProcurementBUId": null,
    "ProcurementBU": null,
    "OrganizationId": -2,
    "OrganizationCode": "VMIMFG3",
    "OrganizationName": null,
    "Subinventory": null,
    "SubinventoryDescription": null,
    "DelivertoLocationId": null,
    "DelivertoLocationName": null,
    "ShipToLocation": "VMIMFG3",
    "InventoryItemId": -2,
    "VmiItemId": null,
    "ItemNumber": "VMI-P200",
    "ItemDescription": null,
    "ItemCategory": "",
    "SupplierItemId": null,
    "SupplierItemName": null,
    "ReplenishmentQuantity": 10,
    "UnitOfMeasure": null,
    "UOMCode": null,
    "Status": null,
    "StatusCode": null,
    "DeliveryDate": "2018-12-10",
    "ProcessId": null,
    "SubmittedDate": null,
    "Notes": "Notes to the Buyer",
    "RequisitionId": null,
    "RequisitionNumber": null,
    "PurchaseOrderNumber": null,
    "PaymentNumber": null,
    "ShipmentNumber": null,
    "ReceiptNumber": null,
    "InvoiceNumber": null,
    "RequisitionRequesterId": null,
    "RequisitionRequesterName": null,
    "CreatedBy": "CVSUPPD05",
    "CreationDate": "2018-10-30T20:47:17+00:00",
    "LastUpdatedBy": "CVSUPPD05",
    "LastUpdateDate": "2018-10-30T20:47:17.136+00:00",
    "links": [
        {
            "rel": "self"
        }
    ]
}

Back to Top