POST api/MaterialRcving
Request Information
URI Parameters
None.
Body Parameters
materialReceiving| Name | Description | Type | Additional information |
|---|---|---|---|
| receivingKey | globally unique identifier |
None. |
|
| partnerID | globally unique identifier |
None. |
|
| eta | date |
None. |
|
| etd | date |
None. |
|
| blnumber | string |
None. |
|
| shipfrom | string |
None. |
|
| shipto | string |
None. |
|
| owner | string |
None. |
|
| materialShipmentKey | globally unique identifier |
None. |
|
| createdBy | string |
None. |
|
| createdOn | date |
None. |
|
| confirmedBy | string |
None. |
|
| confirmedOn | date |
None. |
|
| bill_number | string |
None. |
|
| bill | bill |
None. |
|
| partner | partner |
None. |
|
| purchaseMaterialShipment | purchaseMaterialShipment |
None. |
|
| materialReceivingDetails | Collection of materialReceivingDetail |
None. |
|
| isNew | boolean |
None. |
|
| isConfimed | boolean |
None. |
|
| relatedBLNumber | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"receivingKey": "44374381-87df-433e-b4db-e6bed53efc54",
"partnerID": "36356336-2755-4632-a75b-2e9ab4773b6a",
"eta": "2026-10-26T20:44:34.8426091-07:00",
"etd": "2026-10-26T20:44:34.8426091-07:00",
"blnumber": "sample string 4",
"shipfrom": "sample string 5",
"shipto": "sample string 6",
"owner": "sample string 7",
"materialShipmentKey": "76de4132-44d0-4033-97b1-3948e27fef55",
"createdBy": "sample string 8",
"createdOn": "2026-10-26T20:44:34.8426091-07:00",
"confirmedBy": "sample string 9",
"confirmedOn": "2026-10-26T20:44:34.8426091-07:00",
"bill_number": "sample string 10",
"partner": {
"isNew": true,
"isDeleted": true,
"partnerID": "a0f24c04-56f3-4af3-b51d-e86b2740c6a1",
"companyName": "sample string 4",
"isVendor": true,
"isBuyer": true,
"isConsignee": true,
"companyCode": "sample string 5",
"ein": "sample string 6",
"terms": "sample string 7",
"memo": "sample string 8",
"isAutoPo": true,
"consigneeNumber": "sample string 9",
"isStock": true,
"apiServer": "sample string 10",
"contacts": [
{
"contactID": "8cb4013a-fb35-4ef3-890c-943d57413fa7",
"department": "sample string 2",
"name": "sample string 3",
"email": "sample string 4",
"phone": "sample string 5",
"mobile": "sample string 6",
"messengerID": "sample string 7",
"partnerID": "ae2fa9d0-51ff-4a9f-ae8e-0fa5c3d3174d"
},
{
"contactID": "8cb4013a-fb35-4ef3-890c-943d57413fa7",
"department": "sample string 2",
"name": "sample string 3",
"email": "sample string 4",
"phone": "sample string 5",
"mobile": "sample string 6",
"messengerID": "sample string 7",
"partnerID": "ae2fa9d0-51ff-4a9f-ae8e-0fa5c3d3174d"
}
],
"incharges": [
{
"inchargeID": "a19c4480-fbea-43e4-b08b-86585a41aae9",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "59d1fef9-7071-479e-8b74-092a0b758d47"
},
{
"inchargeID": "a19c4480-fbea-43e4-b08b-86585a41aae9",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "59d1fef9-7071-479e-8b74-092a0b758d47"
}
],
"locationAddresses": [
{
"locationAddressID": "c960c03f-aa39-46e4-ab4d-4672a7af8cbd",
"locationtype": "sample string 2",
"department": "sample string 3",
"locationName": "sample string 4",
"address1": "sample string 5",
"address2": "sample string 6",
"city": "sample string 7",
"state": "sample string 8",
"postalCode": "sample string 9",
"partnerID": "01a46e94-fe9f-4194-b817-1655ad8a4a69"
},
{
"locationAddressID": "c960c03f-aa39-46e4-ab4d-4672a7af8cbd",
"locationtype": "sample string 2",
"department": "sample string 3",
"locationName": "sample string 4",
"address1": "sample string 5",
"address2": "sample string 6",
"city": "sample string 7",
"state": "sample string 8",
"postalCode": "sample string 9",
"partnerID": "01a46e94-fe9f-4194-b817-1655ad8a4a69"
}
]
},
"materialReceivingDetails": [
{
"rcvingDetailKey": "cbf569c9-b3e6-4cfa-8c4a-be198fde7bae",
"receivingKey": "fc9f96e5-12cc-4bd5-b89a-99b9f605d891",
"category": "sample string 3",
"print": "sample string 4",
"poNumber": "sample string 5",
"description": "sample string 6",
"color": "sample string 7",
"qty": 8.0,
"cost": 9.0,
"currentQty": 10.0,
"poDetailId": "ab73d836-1d1b-4b14-99e7-571ec29f41cb",
"materialReceivingDetailAssigns": [
{
"rcvingDetailAssignKey": "3237af2c-5efa-4c5d-9b7d-05ba8324e87e",
"rcvingDetailKey": "0e7c5303-1c71-461f-a510-1cdfa95b7fc6",
"detailId": "14b09e1d-43c9-4094-9383-2dfaa37f9fbc",
"orderQty": 3,
"assignedQty": 4.0,
"yield": 5.0,
"actualYield": 1.0,
"mType": "sample string 6",
"itemCode": "sample string 2",
"colorName": "sample string 3",
"lineQty": 15
},
{
"rcvingDetailAssignKey": "3237af2c-5efa-4c5d-9b7d-05ba8324e87e",
"rcvingDetailKey": "0e7c5303-1c71-461f-a510-1cdfa95b7fc6",
"detailId": "14b09e1d-43c9-4094-9383-2dfaa37f9fbc",
"orderQty": 3,
"assignedQty": 4.0,
"yield": 5.0,
"actualYield": 1.0,
"mType": "sample string 6",
"itemCode": "sample string 2",
"colorName": "sample string 3",
"lineQty": 15
}
],
"isNew": true,
"isDeleted": true,
"curQty": 0.0,
"styleNumber": "sample string 13",
"colorCode": "sample string 14",
"myPoNumber": "sample string 15"
},
{
"rcvingDetailKey": "cbf569c9-b3e6-4cfa-8c4a-be198fde7bae",
"receivingKey": "fc9f96e5-12cc-4bd5-b89a-99b9f605d891",
"category": "sample string 3",
"print": "sample string 4",
"poNumber": "sample string 5",
"description": "sample string 6",
"color": "sample string 7",
"qty": 8.0,
"cost": 9.0,
"currentQty": 10.0,
"poDetailId": "ab73d836-1d1b-4b14-99e7-571ec29f41cb",
"materialReceivingDetailAssigns": [
{
"rcvingDetailAssignKey": "3237af2c-5efa-4c5d-9b7d-05ba8324e87e",
"rcvingDetailKey": "0e7c5303-1c71-461f-a510-1cdfa95b7fc6",
"detailId": "14b09e1d-43c9-4094-9383-2dfaa37f9fbc",
"orderQty": 3,
"assignedQty": 4.0,
"yield": 5.0,
"actualYield": 1.0,
"mType": "sample string 6",
"itemCode": "sample string 2",
"colorName": "sample string 3",
"lineQty": 15
},
{
"rcvingDetailAssignKey": "3237af2c-5efa-4c5d-9b7d-05ba8324e87e",
"rcvingDetailKey": "0e7c5303-1c71-461f-a510-1cdfa95b7fc6",
"detailId": "14b09e1d-43c9-4094-9383-2dfaa37f9fbc",
"orderQty": 3,
"assignedQty": 4.0,
"yield": 5.0,
"actualYield": 1.0,
"mType": "sample string 6",
"itemCode": "sample string 2",
"colorName": "sample string 3",
"lineQty": 15
}
],
"isNew": true,
"isDeleted": true,
"curQty": 0.0,
"styleNumber": "sample string 13",
"colorCode": "sample string 14",
"myPoNumber": "sample string 15"
}
],
"isNew": true,
"isConfimed": true,
"relatedBLNumber": "sample string 5"
}
application/xml, text/xml
Sample:
XML example omitted: automatic generation is unsafe for cyclic entity models. XML API requests and responses remain available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
materialReceiving| Name | Description | Type | Additional information |
|---|---|---|---|
| receivingKey | globally unique identifier |
None. |
|
| partnerID | globally unique identifier |
None. |
|
| eta | date |
None. |
|
| etd | date |
None. |
|
| blnumber | string |
None. |
|
| shipfrom | string |
None. |
|
| shipto | string |
None. |
|
| owner | string |
None. |
|
| materialShipmentKey | globally unique identifier |
None. |
|
| createdBy | string |
None. |
|
| createdOn | date |
None. |
|
| confirmedBy | string |
None. |
|
| confirmedOn | date |
None. |
|
| bill_number | string |
None. |
|
| bill | bill |
None. |
|
| partner | partner |
None. |
|
| purchaseMaterialShipment | purchaseMaterialShipment |
None. |
|
| materialReceivingDetails | Collection of materialReceivingDetail |
None. |
|
| isNew | boolean |
None. |
|
| isConfimed | boolean |
None. |
|
| relatedBLNumber | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"receivingKey": "c5b93bae-aca1-4c21-9bcf-203b49e4e74f",
"partnerID": "e339fc3f-9f24-4664-acb7-c03312258458",
"eta": "2026-10-26T20:44:34.8581583-07:00",
"etd": "2026-10-26T20:44:34.8581583-07:00",
"blnumber": "sample string 4",
"shipfrom": "sample string 5",
"shipto": "sample string 6",
"owner": "sample string 7",
"materialShipmentKey": "64c64769-5c16-4f3e-b854-193fa349d6ae",
"createdBy": "sample string 8",
"createdOn": "2026-10-26T20:44:34.8581583-07:00",
"confirmedBy": "sample string 9",
"confirmedOn": "2026-10-26T20:44:34.8581583-07:00",
"bill_number": "sample string 10",
"partner": {
"isNew": true,
"isDeleted": true,
"partnerID": "81a7c6a9-dd68-4873-ac25-951021ee766f",
"companyName": "sample string 4",
"isVendor": true,
"isBuyer": true,
"isConsignee": true,
"companyCode": "sample string 5",
"ein": "sample string 6",
"terms": "sample string 7",
"memo": "sample string 8",
"isAutoPo": true,
"consigneeNumber": "sample string 9",
"isStock": true,
"apiServer": "sample string 10",
"contacts": [
{
"contactID": "a7885fc8-7f39-4f6b-b80f-206c5cb8cd3f",
"department": "sample string 2",
"name": "sample string 3",
"email": "sample string 4",
"phone": "sample string 5",
"mobile": "sample string 6",
"messengerID": "sample string 7",
"partnerID": "aebec449-223e-4dc6-8db9-9c53e2ad5304"
},
{
"contactID": "a7885fc8-7f39-4f6b-b80f-206c5cb8cd3f",
"department": "sample string 2",
"name": "sample string 3",
"email": "sample string 4",
"phone": "sample string 5",
"mobile": "sample string 6",
"messengerID": "sample string 7",
"partnerID": "aebec449-223e-4dc6-8db9-9c53e2ad5304"
}
],
"incharges": [
{
"inchargeID": "4c0fdc7a-0a58-4968-bddc-6314580ca4cb",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "3759b517-1900-45f1-b385-ab2f6ad47e4e"
},
{
"inchargeID": "4c0fdc7a-0a58-4968-bddc-6314580ca4cb",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "3759b517-1900-45f1-b385-ab2f6ad47e4e"
}
],
"locationAddresses": [
{
"locationAddressID": "54a0491e-20c3-4a9b-9de4-2a9dd18dadf3",
"locationtype": "sample string 2",
"department": "sample string 3",
"locationName": "sample string 4",
"address1": "sample string 5",
"address2": "sample string 6",
"city": "sample string 7",
"state": "sample string 8",
"postalCode": "sample string 9",
"partnerID": "840ca973-c463-4942-9d08-35c99317f220"
},
{
"locationAddressID": "54a0491e-20c3-4a9b-9de4-2a9dd18dadf3",
"locationtype": "sample string 2",
"department": "sample string 3",
"locationName": "sample string 4",
"address1": "sample string 5",
"address2": "sample string 6",
"city": "sample string 7",
"state": "sample string 8",
"postalCode": "sample string 9",
"partnerID": "840ca973-c463-4942-9d08-35c99317f220"
}
]
},
"materialReceivingDetails": [
{
"rcvingDetailKey": "6cf31998-e7f2-4b4e-8c67-b794087e582f",
"receivingKey": "1385fede-5b91-4f4b-946d-3a25c165346e",
"category": "sample string 3",
"print": "sample string 4",
"poNumber": "sample string 5",
"description": "sample string 6",
"color": "sample string 7",
"qty": 8.0,
"cost": 9.0,
"currentQty": 10.0,
"poDetailId": "7961dbd8-6696-4a97-9087-36ee5c3ed22a",
"materialReceivingDetailAssigns": [
{
"rcvingDetailAssignKey": "1e99efaf-d14f-481c-abc2-d60ca492aa11",
"rcvingDetailKey": "759309b0-cab0-4cc4-8107-2ea2d47ac109",
"detailId": "c204e847-68be-4814-ab43-b93340250101",
"orderQty": 3,
"assignedQty": 4.0,
"yield": 5.0,
"actualYield": 1.0,
"mType": "sample string 6",
"itemCode": "sample string 2",
"colorName": "sample string 3",
"lineQty": 15
},
{
"rcvingDetailAssignKey": "1e99efaf-d14f-481c-abc2-d60ca492aa11",
"rcvingDetailKey": "759309b0-cab0-4cc4-8107-2ea2d47ac109",
"detailId": "c204e847-68be-4814-ab43-b93340250101",
"orderQty": 3,
"assignedQty": 4.0,
"yield": 5.0,
"actualYield": 1.0,
"mType": "sample string 6",
"itemCode": "sample string 2",
"colorName": "sample string 3",
"lineQty": 15
}
],
"isNew": true,
"isDeleted": true,
"curQty": 0.0,
"styleNumber": "sample string 13",
"colorCode": "sample string 14",
"myPoNumber": "sample string 15"
},
{
"rcvingDetailKey": "6cf31998-e7f2-4b4e-8c67-b794087e582f",
"receivingKey": "1385fede-5b91-4f4b-946d-3a25c165346e",
"category": "sample string 3",
"print": "sample string 4",
"poNumber": "sample string 5",
"description": "sample string 6",
"color": "sample string 7",
"qty": 8.0,
"cost": 9.0,
"currentQty": 10.0,
"poDetailId": "7961dbd8-6696-4a97-9087-36ee5c3ed22a",
"materialReceivingDetailAssigns": [
{
"rcvingDetailAssignKey": "1e99efaf-d14f-481c-abc2-d60ca492aa11",
"rcvingDetailKey": "759309b0-cab0-4cc4-8107-2ea2d47ac109",
"detailId": "c204e847-68be-4814-ab43-b93340250101",
"orderQty": 3,
"assignedQty": 4.0,
"yield": 5.0,
"actualYield": 1.0,
"mType": "sample string 6",
"itemCode": "sample string 2",
"colorName": "sample string 3",
"lineQty": 15
},
{
"rcvingDetailAssignKey": "1e99efaf-d14f-481c-abc2-d60ca492aa11",
"rcvingDetailKey": "759309b0-cab0-4cc4-8107-2ea2d47ac109",
"detailId": "c204e847-68be-4814-ab43-b93340250101",
"orderQty": 3,
"assignedQty": 4.0,
"yield": 5.0,
"actualYield": 1.0,
"mType": "sample string 6",
"itemCode": "sample string 2",
"colorName": "sample string 3",
"lineQty": 15
}
],
"isNew": true,
"isDeleted": true,
"curQty": 0.0,
"styleNumber": "sample string 13",
"colorCode": "sample string 14",
"myPoNumber": "sample string 15"
}
],
"isNew": true,
"isConfimed": true,
"relatedBLNumber": "sample string 5"
}
application/xml, text/xml
Sample:
XML example omitted: automatic generation is unsafe for cyclic entity models. XML API requests and responses remain available.