Create Single Shipment
  • 06 Jan 2026
  • 3 Minutes to read
  • Dark
    Light

Create Single Shipment

  • Dark
    Light

Article summary

Post
/po-rest-api/jersey/v1/shipmentReceiving

Create Purchase Order Shipment

This API endpoint is used to create PO Shipment lines within the CMiC system. It allows users to submit detailed information regarding shipments, including vendor details, shipment dates, and quantities received.

UI Location

This functionality can be accessed in the CMiC user interface at:
ASSET MANAGEMENT - Purchase Order - Receipt- Enter Wareshouse/Job Receipt

Method: POST
Endpoint: po-rest-api/jersey/v1/shipmentReceiving

ObjectNameTypeNullableComments
poshipmentposhp_comp_codevarchar2(8)NoCompany code
poshp_comp_namevarchar2(30)YesCompany name
poshp_shipm_rec_locvarchar2(7)YesShipment receiving location code
poshp_shipm_rec_loc_namevarchar2(60)YesShipment receiving location name
poshp_shipm_numvarchar2(20)YesShipment number
poshp_shiplist_numvarchar2(20)YesShiplist number
poshp_vendor_codevarchar2(8)YesVendor code
poshp_vendor_namevarchar2(50)YesVendor name
poshp_shipm_rec_datedateYesShipment receiving date
poshp_receivervarchar2(30)YesReceiver identifier
poshp_receiver_namevarchar2(30)YesReceiver name
poshp_po_numvarchar2(11)YesPurchase order number
poshp_po_rel_numnumber(11)YesPurchase order release number
poshp_appr_flagvarchar2(1)YesApproval flag (e.g., Y/N)
poshp_shipm_methodvarchar2(5)YesShipment method code
poshp_shipm_method_namevarchar2(30)YesShipment method name
poshp_ship_linevarchar2(3)YesShipping line identifier
poshp_trnsp_meanvarchar2(3)YesTransport means code
poshp_trnsp_mean_numvarchar2(16)YesTransport means number
poshp_trnsp_doc_numvarchar2(16)YesTransport document number
poshp_remarksvarchar2(250)YesAdditional remarks or comments
poshp_batch_numnumber(15)YesBatch number
poshp_v_uuidvarchar2(64)YesUnique identifier (UUID) for version tracking
poshipmdetposhpd_comp_codevarchar2(8)NoCompany code
poshpd_comp_namevarchar2(30)YesCompany name
poshpd_line_numnumber(6)NoDocument line number
poshpd_po_numvarchar2(11)YesPurchase order number
poshpd_po_rel_numnumber(11)YesPO release number
poshpd_po_line_numnumber(6)YesPO line number
poshpd_item_classvarchar2(4)YesItem class/category code
poshpd_item_codevarchar2(16)YesUnique item identifier
poshpd_item_namevarchar2(4000)YesItem name or description
poshpd_item_typevarchar2(2)YesItem type code
poshpd_item_wm_codevarchar2(2)YesWarehouse mgmt code for item
poshpd_loc_codevarchar2(7)YesStorage location code
poshpd_wm_codevarchar2(2)YesWarehouse code
poshpd_receiv_qtynumber(16,8)YesReceived quantity
poshpd_reject_qtynumber(16,8)YesRejected quantity
poshpd_claim_qtynumber(16,8)YesClaimed quantity
poshpd_unit_costnumberYesUnit cost
poshpd_appr_flagvarchar2(1)YesApproval flag
poshpd_cost_post_datedateYesDate of cost posting
poshpd_bch_numnumber(11)YesBatch number
poshpd_allocated_qtynumber(16,8)YesAllocated quantity
poshpd_shipm_numvarchar2(20)YesShipment number
poshpd_shiplist_numvarchar2(20)YesShipment list number
poshpd_shipm_methodvarchar2(5)YesShipment method
poshpd_ship_linevarchar2(3)YesShipping line code
poshpd_trnsp_meanvarchar2(3)YesTransport means
poshpd_trnsp_mean_numvarchar2(16)YesTransport means number
poshpd_trnsp_doc_numvarchar2(16)YesTransport document number
poshpd_remarksvarchar2(250)YesAdditional remarks
poshpd_receivervarchar2(30)YesShipment receiver name
poshpd_shipm_rec_datedateYesShipment received date
poshpd_iv_flagvarchar2(1)YesInvoice flag
poshpd_tenant_idvarchar2(30)YesTenant ID
Control Fieldscompanyvarchar2(8)NoCompany code
postFlagvarchar2(1)NoPosting Flag - Y or N
postDatedateYesPosting date - Required if Post Flag is Y
batchNumnumber(11)YesBatch Num - For Job receipt, provide either valid batch num or batch name. Leaving NULL will create a Warehouse receipt
batchNamevarchar2(30)YesBatch Name - For Job receipt, provide either valid batch num or batch name. Leaving NULL will create a Warehouse receipt

Request Body Format

The request should be sent as a JSON object containing the following structure:

{
  "data": {
    "shipment": [
      {
        "poshpShipmRecLoc": "string",      // Location of shipment receiving
        "poshpReceiver": "string",          // Receiver's name
        "poshpVendorCode": "string",        // Vendor code
        "poshpShipmRecDate": "YYYY-MM-DD",  // Shipment receiving date
        "poshpPoNum": "string",              // Purchase order number
        "poshpPoRelNum": "integer",          // Purchase order release number
        "poshpShipmNum": "string",           // Shipment number
        "poshpShiplistNum": "string",        // Shipment list number
        "poshpRemarks": "string",            // Additional remarks
        "poshpVUuid": "string",              // UUID for the shipment
        "detail": [
          {
            "poshpdPoLineNum": "integer",    // Purchase order line number
            "poshpdPoNum": "string",          // Purchase order number
            "poshpdPoRelNum": "integer",      // Purchase order release number
            "poshpdShipmNum": "string",       // Shipment number
            "poshpdShiplistNum": "string",    // Ship list number
            "poshpdWmCode": "string",         // WM code
            "poshpdReceivQty": "integer",     // Quantity received
            "poshpdClaimQty": "integer|null", // Quantity claimed
            "poshpdRejectQty": "integer|null",// Quantity rejected
            "poshpdVUuid": "string"           // UUID for the detail
          }
        ]
      }
    ]
  },
  "company": "string",                     // Company code
  "postFlag": "Y/N",                      // Flag to indicate posting
  "postDate": "YYYY-MM-DD",               // Posting date
  "batchNum": "integer",                  // Batch number
  "batchName": "string"                   // Name of the batch
}

Expected Response

Upon successful execution, the API will return a response with a status code of 201. The response will be in JSON format, indicating the success of the operation. The response bod will typically confirm the successful creation of the purchase order shipment lines

Security
HTTP
Type basic

Basic authentication

Header parameters
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceItem+json
Body parameters
object
Example{ "data": { "shipment": [ { "poshpShipmRecLoc": "MAIN", "poshpReceiver": "DA", "poshpVendorCode": "AXIS", "poshpShipmRecDate": "2025-06-27", "poshpPoNum": "ZZ-0093", "poshpPoRelNum": 1, "poshpShipmNum": "1234", "poshpShiplistNum": "1234", "poshpRemarks": "", "poshpVUuid": "", "detail": [ { "poshpdPoLineNum": 1, "poshpdPoNum": "ZZ-0093", "poshpdPoRelNum": 1, "poshpdShipmNum": "", "poshpdShiplistNum": "", "poshpdWmCode": "NA", "poshpdReceivQty": 1, "poshpdClaimQty": null, "poshpdRejectQty": null, "poshpdVUuid": "" }, { "poshpdPoLineNum": 2, "poshpdPoNum": "ZZ-0093", "poshpdPoRelNum": 1, "poshpdShipmNum": "", "poshpdShiplistNum": "", "poshpdWmCode": "NA", "poshpdReceivQty": 2, "poshpdClaimQty": null, "poshpdRejectQty": null, "poshpdVUuid": "" } ] } ] }, "company": "ZZ", "postFlag": "Y", "postDate": "2025-07-15", "batchNum": null, "batchName": "" }
Responses
201

Successful response