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": "1b6aaaf4-6c36-4157-bcfe-fcd34f9101f6",
"partnerID": "321c0b9b-a08a-406c-a684-0f1d9bb3fbe3",
"eta": "2026-01-13T15:57:46.6431066-08:00",
"etd": "2026-01-13T15:57:46.6431066-08:00",
"blnumber": "sample string 4",
"shipfrom": "sample string 5",
"shipto": "sample string 6",
"owner": "sample string 7",
"materialShipmentKey": "b56ef769-d6d1-4942-a401-8a93fc8fe2c9",
"createdBy": "sample string 8",
"createdOn": "2026-01-13T15:57:46.6431066-08:00",
"confirmedBy": "sample string 9",
"confirmedOn": "2026-01-13T15:57:46.6431066-08:00",
"bill_number": "sample string 10",
"partner": {
"isNew": true,
"isDeleted": true,
"partnerID": "1478ba4e-14da-482a-aa02-834b34cf4ca7",
"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": "8d0004d9-0174-4298-85e4-5f7e592b4167",
"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": "7b6bc9c9-a36c-432f-9b42-992207178b40"
},
{
"contactID": "8d0004d9-0174-4298-85e4-5f7e592b4167",
"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": "7b6bc9c9-a36c-432f-9b42-992207178b40"
}
],
"incharges": [
{
"inchargeID": "9df4f9ff-e743-45ac-9032-2bfd685c34b4",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "f1aa45f8-a3e4-40be-91fb-b8f1b380815e"
},
{
"inchargeID": "9df4f9ff-e743-45ac-9032-2bfd685c34b4",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "f1aa45f8-a3e4-40be-91fb-b8f1b380815e"
}
],
"locationAddresses": [
{
"locationAddressID": "97e45c6e-6826-46b0-abe5-bbaeb87bebb8",
"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": "50e427a7-2045-425e-8187-20646a93f7f4"
},
{
"locationAddressID": "97e45c6e-6826-46b0-abe5-bbaeb87bebb8",
"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": "50e427a7-2045-425e-8187-20646a93f7f4"
}
]
},
"materialReceivingDetails": [
{
"rcvingDetailKey": "55e37d94-1b34-4eac-90d0-02c865d3c393",
"receivingKey": "aba918b1-a80f-4066-aef2-d1250082c146",
"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": "4be165ec-5248-4388-bd46-a43fe6bea8e4",
"materialReceivingDetailAssigns": [
{
"rcvingDetailAssignKey": "3a5d958d-a78b-40d5-87c1-6bcbf61d1852",
"rcvingDetailKey": "ca6e8fff-a875-4579-b266-cecbc412b073",
"detailId": "a570b1d3-9063-4401-8c42-2148c0ac93f2",
"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": "3a5d958d-a78b-40d5-87c1-6bcbf61d1852",
"rcvingDetailKey": "ca6e8fff-a875-4579-b266-cecbc412b073",
"detailId": "a570b1d3-9063-4401-8c42-2148c0ac93f2",
"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": "55e37d94-1b34-4eac-90d0-02c865d3c393",
"receivingKey": "aba918b1-a80f-4066-aef2-d1250082c146",
"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": "4be165ec-5248-4388-bd46-a43fe6bea8e4",
"materialReceivingDetailAssigns": [
{
"rcvingDetailAssignKey": "3a5d958d-a78b-40d5-87c1-6bcbf61d1852",
"rcvingDetailKey": "ca6e8fff-a875-4579-b266-cecbc412b073",
"detailId": "a570b1d3-9063-4401-8c42-2148c0ac93f2",
"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": "3a5d958d-a78b-40d5-87c1-6bcbf61d1852",
"rcvingDetailKey": "ca6e8fff-a875-4579-b266-cecbc412b073",
"detailId": "a570b1d3-9063-4401-8c42-2148c0ac93f2",
"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
Sample:
Sample not available.
text/xml
Sample:
Sample not 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": "fe1fc7bd-474b-47f0-8d1c-6e8d1eb258bc",
"partnerID": "eaf89826-43a0-477a-b752-1c3c6924669a",
"eta": "2026-01-13T15:57:46.7056645-08:00",
"etd": "2026-01-13T15:57:46.7056645-08:00",
"blnumber": "sample string 4",
"shipfrom": "sample string 5",
"shipto": "sample string 6",
"owner": "sample string 7",
"materialShipmentKey": "cf0f8902-186d-4c05-8963-0e70d18c67eb",
"createdBy": "sample string 8",
"createdOn": "2026-01-13T15:57:46.7056645-08:00",
"confirmedBy": "sample string 9",
"confirmedOn": "2026-01-13T15:57:46.7056645-08:00",
"bill_number": "sample string 10",
"partner": {
"isNew": true,
"isDeleted": true,
"partnerID": "a78872b6-6721-4d46-9446-d85e0bd7eae9",
"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": "55538ec5-ce90-4d60-88ad-62c084394b06",
"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": "7293b816-b02c-4da2-92d5-d2f38e92eabc"
},
{
"contactID": "55538ec5-ce90-4d60-88ad-62c084394b06",
"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": "7293b816-b02c-4da2-92d5-d2f38e92eabc"
}
],
"incharges": [
{
"inchargeID": "9b966e1f-1247-4dae-b610-02bf9d708195",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "7924113a-2093-4f8b-932d-9e54f52ee20a"
},
{
"inchargeID": "9b966e1f-1247-4dae-b610-02bf9d708195",
"inchargeEmail": "sample string 2",
"confirmEmail": "sample string 3",
"partnerID": "7924113a-2093-4f8b-932d-9e54f52ee20a"
}
],
"locationAddresses": [
{
"locationAddressID": "5bebc8d2-b311-4e97-a8e4-a3828b8cd429",
"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": "12f59242-f9c6-4dbb-810c-fb68db82ddd2"
},
{
"locationAddressID": "5bebc8d2-b311-4e97-a8e4-a3828b8cd429",
"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": "12f59242-f9c6-4dbb-810c-fb68db82ddd2"
}
]
},
"materialReceivingDetails": [
{
"rcvingDetailKey": "efcabd45-4494-4893-ae0d-11be0dcb0794",
"receivingKey": "8cf1987c-3c45-46f3-b6c8-3b18395011df",
"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": "96a153d3-f3e5-4681-b722-97637e75bf8a",
"materialReceivingDetailAssigns": [
{
"rcvingDetailAssignKey": "2f9e4808-322e-4591-a7f0-76f2c2868a2d",
"rcvingDetailKey": "7e1a8342-10d7-41c3-bbeb-e5ab4d3ce0ab",
"detailId": "8852ba3c-6434-425a-b943-80ac2108345b",
"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": "2f9e4808-322e-4591-a7f0-76f2c2868a2d",
"rcvingDetailKey": "7e1a8342-10d7-41c3-bbeb-e5ab4d3ce0ab",
"detailId": "8852ba3c-6434-425a-b943-80ac2108345b",
"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": "efcabd45-4494-4893-ae0d-11be0dcb0794",
"receivingKey": "8cf1987c-3c45-46f3-b6c8-3b18395011df",
"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": "96a153d3-f3e5-4681-b722-97637e75bf8a",
"materialReceivingDetailAssigns": [
{
"rcvingDetailAssignKey": "2f9e4808-322e-4591-a7f0-76f2c2868a2d",
"rcvingDetailKey": "7e1a8342-10d7-41c3-bbeb-e5ab4d3ce0ab",
"detailId": "8852ba3c-6434-425a-b943-80ac2108345b",
"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": "2f9e4808-322e-4591-a7f0-76f2c2868a2d",
"rcvingDetailKey": "7e1a8342-10d7-41c3-bbeb-e5ab4d3ce0ab",
"detailId": "8852ba3c-6434-425a-b943-80ac2108345b",
"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
Sample:
Sample not available.
text/xml
Sample:
Sample not available.