GET api/PurchaseMaterialShip/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required

Body Parameters

None.

Response Information

Resource Description

purchaseMaterialShipment

Name	Type	Additional information
isNew	boolean	None.
isSkip	boolean	None.
updatePrice	boolean	None.
materialShipmentKey	globally unique identifier	None.
shipBL	string	None.
shipBy	string	None.
etd	date	None.
eta	date	None.
rcvdOn	date	None.
shipFrom	string	None.
shipTo	string	None.
createdOn	date	None.
createdBy	string	None.
modifiedOn	date	None.
modifiedBy	string	None.
materialReceivings	Collection of materialReceiving	None.
purchaseOrderDetailWIPs	Collection of purchaseOrderDetailWIP	None.
purchaseOrderDetailWIPTemps	Collection of purchaseOrderDetailWIPTemp	None.

Response Formats

application/json, text/json

Sample:

{
  "isNew": true,
  "isSkip": true,
  "updatePrice": true,
  "materialShipmentKey": "e73ff7e3-ccaa-4114-b30a-48b66e340244",
  "shipBL": "sample string 5",
  "shipBy": "sample string 6",
  "etd": "2026-10-26T20:44:34.9519039-07:00",
  "eta": "2026-10-26T20:44:34.9519039-07:00",
  "rcvdOn": "2026-10-26T20:44:34.9519039-07:00",
  "shipFrom": "sample string 9",
  "shipTo": "sample string 10",
  "createdOn": "2026-10-26T20:44:34.9519039-07:00",
  "createdBy": "sample string 11",
  "modifiedOn": "2026-10-26T20:44:34.9519039-07:00",
  "modifiedBy": "sample string 12",
  "materialReceivings": [
    {
      "receivingKey": "877d3bbd-91dc-4747-89c3-b0930be10bce",
      "partnerID": "d5b7af33-164a-4ef8-a30e-89dc9f627a83",
      "eta": "2026-10-26T20:44:34.9519039-07:00",
      "etd": "2026-10-26T20:44:34.9519039-07:00",
      "blnumber": "sample string 4",
      "shipfrom": "sample string 5",
      "shipto": "sample string 6",
      "owner": "sample string 7",
      "materialShipmentKey": "b822fb4a-e4c9-4925-a37b-7afa6662cf30",
      "createdBy": "sample string 8",
      "createdOn": "2026-10-26T20:44:34.9519039-07:00",
      "confirmedBy": "sample string 9",
      "confirmedOn": "2026-10-26T20:44:34.9519039-07:00",
      "bill_number": "sample string 10",
      "partner": {
        "isNew": true,
        "isDeleted": true,
        "partnerID": "e096e12d-b27a-474f-a273-8047c9fdbd00",
        "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": "c96e081f-5e65-4d0b-b6f4-2d6f9a150f61",
            "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": "ec38b81c-807e-4ac3-ae35-9e810c8bf6e9"
          },
          {
            "contactID": "c96e081f-5e65-4d0b-b6f4-2d6f9a150f61",
            "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": "ec38b81c-807e-4ac3-ae35-9e810c8bf6e9"
          }
        ],
        "incharges": [
          {
            "inchargeID": "11b5ab90-9365-4c46-9977-51ac1203d01c",
            "inchargeEmail": "sample string 2",
            "confirmEmail": "sample string 3",
            "partnerID": "aea88185-9ab8-438d-b666-5172e4e8a00a"
          },
          {
            "inchargeID": "11b5ab90-9365-4c46-9977-51ac1203d01c",
            "inchargeEmail": "sample string 2",
            "confirmEmail": "sample string 3",
            "partnerID": "aea88185-9ab8-438d-b666-5172e4e8a00a"
          }
        ],
        "locationAddresses": [
          {
            "locationAddressID": "0180bd0d-7b2f-4479-861c-b2b0fcfbfdef",
            "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": "e22d91b4-6cc2-448d-a54d-e042a4333554"
          },
          {
            "locationAddressID": "0180bd0d-7b2f-4479-861c-b2b0fcfbfdef",
            "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": "e22d91b4-6cc2-448d-a54d-e042a4333554"
          }
        ]
      },
      "materialReceivingDetails": [
        {
          "rcvingDetailKey": "2a5a2b05-c0d0-446f-ba8e-db589da4d0ef",
          "receivingKey": "2e274e88-900c-458f-b9ce-eaa89382b639",
          "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": "cff0d63d-66e5-4a82-b67b-52266bd3ef1f",
          "materialReceivingDetailAssigns": [
            {
              "rcvingDetailAssignKey": "bfb1212d-1076-4cd1-b1ab-01154eb21951",
              "rcvingDetailKey": "88f51754-94d1-4f53-9b5b-b0c2c6244d1d",
              "detailId": "315b14aa-a944-4629-889c-1fb22f4ca434",
              "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": "bfb1212d-1076-4cd1-b1ab-01154eb21951",
              "rcvingDetailKey": "88f51754-94d1-4f53-9b5b-b0c2c6244d1d",
              "detailId": "315b14aa-a944-4629-889c-1fb22f4ca434",
              "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": "2a5a2b05-c0d0-446f-ba8e-db589da4d0ef",
          "receivingKey": "2e274e88-900c-458f-b9ce-eaa89382b639",
          "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": "cff0d63d-66e5-4a82-b67b-52266bd3ef1f",
          "materialReceivingDetailAssigns": [
            {
              "rcvingDetailAssignKey": "bfb1212d-1076-4cd1-b1ab-01154eb21951",
              "rcvingDetailKey": "88f51754-94d1-4f53-9b5b-b0c2c6244d1d",
              "detailId": "315b14aa-a944-4629-889c-1fb22f4ca434",
              "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": "bfb1212d-1076-4cd1-b1ab-01154eb21951",
              "rcvingDetailKey": "88f51754-94d1-4f53-9b5b-b0c2c6244d1d",
              "detailId": "315b14aa-a944-4629-889c-1fb22f4ca434",
              "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"
    },
    {
      "receivingKey": "877d3bbd-91dc-4747-89c3-b0930be10bce",
      "partnerID": "d5b7af33-164a-4ef8-a30e-89dc9f627a83",
      "eta": "2026-10-26T20:44:34.9519039-07:00",
      "etd": "2026-10-26T20:44:34.9519039-07:00",
      "blnumber": "sample string 4",
      "shipfrom": "sample string 5",
      "shipto": "sample string 6",
      "owner": "sample string 7",
      "materialShipmentKey": "b822fb4a-e4c9-4925-a37b-7afa6662cf30",
      "createdBy": "sample string 8",
      "createdOn": "2026-10-26T20:44:34.9519039-07:00",
      "confirmedBy": "sample string 9",
      "confirmedOn": "2026-10-26T20:44:34.9519039-07:00",
      "bill_number": "sample string 10",
      "partner": {
        "isNew": true,
        "isDeleted": true,
        "partnerID": "e096e12d-b27a-474f-a273-8047c9fdbd00",
        "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": "c96e081f-5e65-4d0b-b6f4-2d6f9a150f61",
            "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": "ec38b81c-807e-4ac3-ae35-9e810c8bf6e9"
          },
          {
            "contactID": "c96e081f-5e65-4d0b-b6f4-2d6f9a150f61",
            "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": "ec38b81c-807e-4ac3-ae35-9e810c8bf6e9"
          }
        ],
        "incharges": [
          {
            "inchargeID": "11b5ab90-9365-4c46-9977-51ac1203d01c",
            "inchargeEmail": "sample string 2",
            "confirmEmail": "sample string 3",
            "partnerID": "aea88185-9ab8-438d-b666-5172e4e8a00a"
          },
          {
            "inchargeID": "11b5ab90-9365-4c46-9977-51ac1203d01c",
            "inchargeEmail": "sample string 2",
            "confirmEmail": "sample string 3",
            "partnerID": "aea88185-9ab8-438d-b666-5172e4e8a00a"
          }
        ],
        "locationAddresses": [
          {
            "locationAddressID": "0180bd0d-7b2f-4479-861c-b2b0fcfbfdef",
            "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": "e22d91b4-6cc2-448d-a54d-e042a4333554"
          },
          {
            "locationAddressID": "0180bd0d-7b2f-4479-861c-b2b0fcfbfdef",
            "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": "e22d91b4-6cc2-448d-a54d-e042a4333554"
          }
        ]
      },
      "materialReceivingDetails": [
        {
          "rcvingDetailKey": "2a5a2b05-c0d0-446f-ba8e-db589da4d0ef",
          "receivingKey": "2e274e88-900c-458f-b9ce-eaa89382b639",
          "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": "cff0d63d-66e5-4a82-b67b-52266bd3ef1f",
          "materialReceivingDetailAssigns": [
            {
              "rcvingDetailAssignKey": "bfb1212d-1076-4cd1-b1ab-01154eb21951",
              "rcvingDetailKey": "88f51754-94d1-4f53-9b5b-b0c2c6244d1d",
              "detailId": "315b14aa-a944-4629-889c-1fb22f4ca434",
              "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": "bfb1212d-1076-4cd1-b1ab-01154eb21951",
              "rcvingDetailKey": "88f51754-94d1-4f53-9b5b-b0c2c6244d1d",
              "detailId": "315b14aa-a944-4629-889c-1fb22f4ca434",
              "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": "2a5a2b05-c0d0-446f-ba8e-db589da4d0ef",
          "receivingKey": "2e274e88-900c-458f-b9ce-eaa89382b639",
          "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": "cff0d63d-66e5-4a82-b67b-52266bd3ef1f",
          "materialReceivingDetailAssigns": [
            {
              "rcvingDetailAssignKey": "bfb1212d-1076-4cd1-b1ab-01154eb21951",
              "rcvingDetailKey": "88f51754-94d1-4f53-9b5b-b0c2c6244d1d",
              "detailId": "315b14aa-a944-4629-889c-1fb22f4ca434",
              "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": "bfb1212d-1076-4cd1-b1ab-01154eb21951",
              "rcvingDetailKey": "88f51754-94d1-4f53-9b5b-b0c2c6244d1d",
              "detailId": "315b14aa-a944-4629-889c-1fb22f4ca434",
              "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"
    }
  ],
  "purchaseOrderDetailWIPs": [
    {
      "isCompleted": true,
      "blnumber": "sample string 2",
      "orderData": {
        "salesOrderNo": "sample string 1",
        "poNumber": "sample string 2",
        "vendorName": "sample string 3",
        "partnerID": "21b01df3-00f4-42c3-9b07-f79da88ef855",
        "orderDate": "2026-10-26T20:44:34.9519039-07:00",
        "isCanceled": true,
        "itemCode": "sample string 5",
        "materialType": "sample string 6",
        "materialColor": "sample string 7",
        "description": "sample string 8",
        "buyerName": "sample string 9",
        "buyerOrderNo": "sample string 10",
        "cost": 11.0,
        "colorID": "sample string 12",
        "fabrication": "sample string 13"
      },
      "poDetailWIPKey": "b49b4385-9ab0-427e-a0e0-53214b30952d",
      "poDetailId": "0dea63a5-77e1-4b85-88a0-4b403d3492d7",
      "shippingQty": 1.0,
      "shippingSample": "sample string 5",
      "fabricETD": "2026-10-26T20:44:34.9519039-07:00",
      "fabricETA": "2026-10-26T20:44:34.9519039-07:00",
      "materialShipmentKey": "ee4a9e11-7654-42a4-ad11-11a750fc1d3b",
      "remark": "sample string 7"
    },
    {
      "isCompleted": true,
      "blnumber": "sample string 2",
      "orderData": {
        "salesOrderNo": "sample string 1",
        "poNumber": "sample string 2",
        "vendorName": "sample string 3",
        "partnerID": "21b01df3-00f4-42c3-9b07-f79da88ef855",
        "orderDate": "2026-10-26T20:44:34.9519039-07:00",
        "isCanceled": true,
        "itemCode": "sample string 5",
        "materialType": "sample string 6",
        "materialColor": "sample string 7",
        "description": "sample string 8",
        "buyerName": "sample string 9",
        "buyerOrderNo": "sample string 10",
        "cost": 11.0,
        "colorID": "sample string 12",
        "fabrication": "sample string 13"
      },
      "poDetailWIPKey": "b49b4385-9ab0-427e-a0e0-53214b30952d",
      "poDetailId": "0dea63a5-77e1-4b85-88a0-4b403d3492d7",
      "shippingQty": 1.0,
      "shippingSample": "sample string 5",
      "fabricETD": "2026-10-26T20:44:34.9519039-07:00",
      "fabricETA": "2026-10-26T20:44:34.9519039-07:00",
      "materialShipmentKey": "ee4a9e11-7654-42a4-ad11-11a750fc1d3b",
      "remark": "sample string 7"
    }
  ],
  "purchaseOrderDetailWIPTemps": [
    {
      "poDetailId": "b653ecc0-ef82-4514-a1bf-11c777a78e0c",
      "shippingQty": 1.0,
      "shippingSample": "sample string 2",
      "fabricETD": "2026-10-26T20:44:34.9519039-07:00",
      "fabricETA": "2026-10-26T20:44:34.9519039-07:00",
      "remark": "sample string 3",
      "materialShipmentKey": "3af4728a-2d1f-4307-98db-13248db35ba2"
    },
    {
      "poDetailId": "b653ecc0-ef82-4514-a1bf-11c777a78e0c",
      "shippingQty": 1.0,
      "shippingSample": "sample string 2",
      "fabricETD": "2026-10-26T20:44:34.9519039-07:00",
      "fabricETA": "2026-10-26T20:44:34.9519039-07:00",
      "remark": "sample string 3",
      "materialShipmentKey": "3af4728a-2d1f-4307-98db-13248db35ba2"
    }
  ]
}

application/xml, text/xml

Sample:

XML example omitted: automatic generation is unsafe for cyclic entity models. XML API requests and responses remain available.