POST utils/v2/ServiceRequestEvent/{serviceRequestEventId}/shipments

The AddShipment.

Request Information

URI Parameters

Name	Description	Type	Additional information
serviceRequestEventId	The serviceRequestEventId.	globally unique identifier	Required

Body Parameters

The shipmentDTO.

ExternalShipmentDTO

Name	Type	Additional information
Oid	string	None.
Id	globally unique identifier	None.
ShipmentNumber	integer	None.
ShipmentName	string	None.
ShipmentType	BaseDTO	None.
FromLocation	LocationDTO	None.
ToLocation	LocationDTO	None.
Created	date	None.
Shipped	date	None.
Received	date	None.
Reconciled	date	None.
ExpectedDeliveryDate	date	None.
InventoryShipmentStatus	BaseDTO	None.
TrackingNumber	string	None.
DeliveryMethod	BaseDTO	None.
ExceptionType	BaseDTO	None.
ExceptionFollowUpDate	date	None.
ExceptionComment	string	None.
LastComments	string	None.
DetailedReconciliationRequired	boolean	None.
Comments	Collection of CommentDTO	None.
Equipment	Collection of EquipmentBasicDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "oid": "sample string 1",
  "id": "00000000-0000-0000-0000-000000000000",
  "shipmentNumber": 2,
  "shipmentName": "sample string 3",
  "shipmentType": {
    "name": "sample string 1",
    "description": "sample string 2",
    "oid": "sample string 3",
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "fromLocation": {
    "oid": "sample string 1",
    "id": "00000000-0000-0000-0000-000000000000",
    "address1": "sample string 2",
    "address2": "sample string 3",
    "campus": "sample string 4",
    "city": "sample string 5",
    "country": "sample string 6",
    "countryCode": "sample string 7",
    "floor": "sample string 8",
    "fullName": "sample string 9",
    "locationId": "dd12cd5b-a41a-40f1-8159-3741704db5b7",
    "name": "sample string 11",
    "number": "sample string 12",
    "postalCode": "sample string 13",
    "region": "sample string 14",
    "room": "sample string 15",
    "state": "sample string 16",
    "stateCode": "sample string 17",
    "category": {
      "name": "sample string 1",
      "description": "sample string 2",
      "oid": "sample string 3",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "locationType": {
      "name": "sample string 1",
      "description": "sample string 2",
      "oid": "sample string 3",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "cartNumber": "sample string 18",
    "requestedDateTime": "sample string 19",
    "locationAdditionalDetails": "sample string 20",
    "lockedAndSecuredComments": "sample string 21",
    "isDefault": true,
    "customers": [
      {
        "name": "sample string 1",
        "description": "sample string 2",
        "oid": "sample string 3",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      {
        "name": "sample string 1",
        "description": "sample string 2",
        "oid": "sample string 3",
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "status": "sample string 23",
    "customFieldList": [
      {
        "oid": "sample string 1",
        "id": "00000000-0000-0000-0000-000000000000",
        "customFieldName": "sample string 2",
        "customFieldCaption": "sample string 3",
        "customFieldExternalLabel": "sample string 4",
        "customFieldExternalReferenceName": "sample string 5",
        "customFieldValue": "sample string 6"
      },
      {
        "oid": "sample string 1",
        "id": "00000000-0000-0000-0000-000000000000",
        "customFieldName": "sample string 2",
        "customFieldCaption": "sample string 3",
        "customFieldExternalLabel": "sample string 4",
        "customFieldExternalReferenceName": "sample string 5",
        "customFieldValue": "sample string 6"
      }
    ]
  },
  "toLocation": {
    "oid": "sample string 1",
    "id": "00000000-0000-0000-0000-000000000000",
    "address1": "sample string 2",
    "address2": "sample string 3",
    "campus": "sample string 4",
    "city": "sample string 5",
    "country": "sample string 6",
    "countryCode": "sample string 7",
    "floor": "sample string 8",
    "fullName": "sample string 9",
    "locationId": "dd12cd5b-a41a-40f1-8159-3741704db5b7",
    "name": "sample string 11",
    "number": "sample string 12",
    "postalCode": "sample string 13",
    "region": "sample string 14",
    "room": "sample string 15",
    "state": "sample string 16",
    "stateCode": "sample string 17",
    "category": {
      "name": "sample string 1",
      "description": "sample string 2",
      "oid": "sample string 3",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "locationType": {
      "name": "sample string 1",
      "description": "sample string 2",
      "oid": "sample string 3",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "cartNumber": "sample string 18",
    "requestedDateTime": "sample string 19",
    "locationAdditionalDetails": "sample string 20",
    "lockedAndSecuredComments": "sample string 21",
    "isDefault": true,
    "customers": [
      {
        "name": "sample string 1",
        "description": "sample string 2",
        "oid": "sample string 3",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      {
        "name": "sample string 1",
        "description": "sample string 2",
        "oid": "sample string 3",
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "status": "sample string 23",
    "customFieldList": [
      {
        "oid": "sample string 1",
        "id": "00000000-0000-0000-0000-000000000000",
        "customFieldName": "sample string 2",
        "customFieldCaption": "sample string 3",
        "customFieldExternalLabel": "sample string 4",
        "customFieldExternalReferenceName": "sample string 5",
        "customFieldValue": "sample string 6"
      },
      {
        "oid": "sample string 1",
        "id": "00000000-0000-0000-0000-000000000000",
        "customFieldName": "sample string 2",
        "customFieldCaption": "sample string 3",
        "customFieldExternalLabel": "sample string 4",
        "customFieldExternalReferenceName": "sample string 5",
        "customFieldValue": "sample string 6"
      }
    ]
  },
  "created": "2024-05-15T00:21:14.5492607-04:00",
  "shipped": "2024-05-15T00:21:14.5492607-04:00",
  "received": "2024-05-15T00:21:14.5492607-04:00",
  "reconciled": "2024-05-15T00:21:14.5492607-04:00",
  "expectedDeliveryDate": "2024-05-15T00:21:14.5492607-04:00",
  "inventoryShipmentStatus": {
    "name": "sample string 1",
    "description": "sample string 2",
    "oid": "sample string 3",
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "trackingNumber": "sample string 9",
  "deliveryMethod": {
    "name": "sample string 1",
    "description": "sample string 2",
    "oid": "sample string 3",
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "exceptionType": {
    "name": "sample string 1",
    "description": "sample string 2",
    "oid": "sample string 3",
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "exceptionFollowUpDate": "2024-05-15T00:21:14.5492607-04:00",
  "exceptionComment": "sample string 11",
  "lastComments": "sample string 12",
  "detailedReconciliationRequired": true,
  "comments": [
    {
      "oid": "sample string 1",
      "id": "00000000-0000-0000-0000-000000000000",
      "description": "sample string 2",
      "userName": "sample string 3",
      "fullName": "sample string 4",
      "creationDate": "sample string 5",
      "serviceRequestEventId": "sample string 6",
      "commentCategoryName": "sample string 7",
      "employeeId": "sample string 8",
      "messageCondition": "sample string 9",
      "acknowledgeDate": "sample string 10",
      "token": "sample string 11"
    },
    {
      "oid": "sample string 1",
      "id": "00000000-0000-0000-0000-000000000000",
      "description": "sample string 2",
      "userName": "sample string 3",
      "fullName": "sample string 4",
      "creationDate": "sample string 5",
      "serviceRequestEventId": "sample string 6",
      "commentCategoryName": "sample string 7",
      "employeeId": "sample string 8",
      "messageCondition": "sample string 9",
      "acknowledgeDate": "sample string 10",
      "token": "sample string 11"
    }
  ],
  "equipment": [
    {
      "assetTag": "sample string 1",
      "isUnlinked": true,
      "manufacturer": "sample string 3",
      "model": "sample string 4",
      "oid": "sample string 5",
      "serialNumber": "sample string 6",
      "service": "sample string 7",
      "id": "00000000-0000-0000-0000-000000000000",
      "quantity": 8,
      "partNumber": "sample string 9",
      "vendorFulfillment": "sample string 10",
      "deviceRole": "sample string 11",
      "equipmentType": "sample string 12",
      "modelCatalogId": "sample string 13"
    },
    {
      "assetTag": "sample string 1",
      "isUnlinked": true,
      "manufacturer": "sample string 3",
      "model": "sample string 4",
      "oid": "sample string 5",
      "serialNumber": "sample string 6",
      "service": "sample string 7",
      "id": "00000000-0000-0000-0000-000000000000",
      "quantity": 8,
      "partNumber": "sample string 9",
      "vendorFulfillment": "sample string 10",
      "deviceRole": "sample string 11",
      "equipmentType": "sample string 12",
      "modelCatalogId": "sample string 13"
    }
  ]
}

application/xml, text/xml

Sample:

<ExternalShipmentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Core.Nexus.Common.DTOs">
  <Comments>
    <CommentDTO>
      <AcknowledgeDate>sample string 10</AcknowledgeDate>
      <CommentCategoryName>sample string 7</CommentCategoryName>
      <CreationDate>sample string 5</CreationDate>
      <Description>sample string 2</Description>
      <EmployeeId>sample string 8</EmployeeId>
      <FullName>sample string 4</FullName>
      <MessageCondition>sample string 9</MessageCondition>
      <Oid>sample string 1</Oid>
      <ServiceRequestEventId>sample string 6</ServiceRequestEventId>
      <Token>sample string 11</Token>
      <UserName>sample string 3</UserName>
    </CommentDTO>
    <CommentDTO>
      <AcknowledgeDate>sample string 10</AcknowledgeDate>
      <CommentCategoryName>sample string 7</CommentCategoryName>
      <CreationDate>sample string 5</CreationDate>
      <Description>sample string 2</Description>
      <EmployeeId>sample string 8</EmployeeId>
      <FullName>sample string 4</FullName>
      <MessageCondition>sample string 9</MessageCondition>
      <Oid>sample string 1</Oid>
      <ServiceRequestEventId>sample string 6</ServiceRequestEventId>
      <Token>sample string 11</Token>
      <UserName>sample string 3</UserName>
    </CommentDTO>
  </Comments>
  <Created>2024-05-15T00:21:14.5492607-04:00</Created>
  <DeliveryMethod>
    <Description>sample string 2</Description>
    <Name>sample string 1</Name>
    <Oid>sample string 3</Oid>
  </DeliveryMethod>
  <DetailedReconciliationRequired>true</DetailedReconciliationRequired>
  <Equipment>
    <EquipmentBasicDTO>
      <AssetTag>sample string 1</AssetTag>
      <DeviceRole>sample string 11</DeviceRole>
      <EquipmentType>sample string 12</EquipmentType>
      <IsUnlinked>true</IsUnlinked>
      <Manufacturer>sample string 3</Manufacturer>
      <Model>sample string 4</Model>
      <ModelCatalogId>sample string 13</ModelCatalogId>
      <Oid>sample string 5</Oid>
      <PartNumber>sample string 9</PartNumber>
      <Quantity>8</Quantity>
      <SerialNumber>sample string 6</SerialNumber>
      <Service>sample string 7</Service>
      <VendorFulfillment>sample string 10</VendorFulfillment>
    </EquipmentBasicDTO>
    <EquipmentBasicDTO>
      <AssetTag>sample string 1</AssetTag>
      <DeviceRole>sample string 11</DeviceRole>
      <EquipmentType>sample string 12</EquipmentType>
      <IsUnlinked>true</IsUnlinked>
      <Manufacturer>sample string 3</Manufacturer>
      <Model>sample string 4</Model>
      <ModelCatalogId>sample string 13</ModelCatalogId>
      <Oid>sample string 5</Oid>
      <PartNumber>sample string 9</PartNumber>
      <Quantity>8</Quantity>
      <SerialNumber>sample string 6</SerialNumber>
      <Service>sample string 7</Service>
      <VendorFulfillment>sample string 10</VendorFulfillment>
    </EquipmentBasicDTO>
  </Equipment>
  <ExceptionComment>sample string 11</ExceptionComment>
  <ExceptionFollowUpDate>2024-05-15T00:21:14.5492607-04:00</ExceptionFollowUpDate>
  <ExceptionType>
    <Description>sample string 2</Description>
    <Name>sample string 1</Name>
    <Oid>sample string 3</Oid>
  </ExceptionType>
  <ExpectedDeliveryDate>2024-05-15T00:21:14.5492607-04:00</ExpectedDeliveryDate>
  <FromLocation>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <Campus>sample string 4</Campus>
    <CartNumber>sample string 18</CartNumber>
    <Category>
      <Description>sample string 2</Description>
      <Name>sample string 1</Name>
      <Oid>sample string 3</Oid>
    </Category>
    <City>sample string 5</City>
    <Country>sample string 6</Country>
    <CountryCode>sample string 7</CountryCode>
    <CustomFieldList>
      <CustomFieldDTO>
        <CustomFieldCaption>sample string 3</CustomFieldCaption>
        <CustomFieldExternalLabel>sample string 4</CustomFieldExternalLabel>
        <CustomFieldExternalReferenceName>sample string 5</CustomFieldExternalReferenceName>
        <CustomFieldName>sample string 2</CustomFieldName>
        <CustomFieldValue>sample string 6</CustomFieldValue>
        <Oid>sample string 1</Oid>
      </CustomFieldDTO>
      <CustomFieldDTO>
        <CustomFieldCaption>sample string 3</CustomFieldCaption>
        <CustomFieldExternalLabel>sample string 4</CustomFieldExternalLabel>
        <CustomFieldExternalReferenceName>sample string 5</CustomFieldExternalReferenceName>
        <CustomFieldName>sample string 2</CustomFieldName>
        <CustomFieldValue>sample string 6</CustomFieldValue>
        <Oid>sample string 1</Oid>
      </CustomFieldDTO>
    </CustomFieldList>
    <Customers>
      <BaseDTO>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Oid>sample string 3</Oid>
      </BaseDTO>
      <BaseDTO>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Oid>sample string 3</Oid>
      </BaseDTO>
    </Customers>
    <Floor>sample string 8</Floor>
    <FullName>sample string 9</FullName>
    <IsDefault>true</IsDefault>
    <LocationAdditionalDetails>sample string 20</LocationAdditionalDetails>
    <LocationId>dd12cd5b-a41a-40f1-8159-3741704db5b7</LocationId>
    <LocationType>
      <Description>sample string 2</Description>
      <Name>sample string 1</Name>
      <Oid>sample string 3</Oid>
    </LocationType>
    <LockedAndSecuredComments>sample string 21</LockedAndSecuredComments>
    <Name>sample string 11</Name>
    <Number>sample string 12</Number>
    <Oid>sample string 1</Oid>
    <PostalCode>sample string 13</PostalCode>
    <Region>sample string 14</Region>
    <RequestedDateTime>sample string 19</RequestedDateTime>
    <Room>sample string 15</Room>
    <State>sample string 16</State>
    <StateCode>sample string 17</StateCode>
    <Status>sample string 23</Status>
  </FromLocation>
  <InventoryShipmentStatus>
    <Description>sample string 2</Description>
    <Name>sample string 1</Name>
    <Oid>sample string 3</Oid>
  </InventoryShipmentStatus>
  <LastComments>sample string 12</LastComments>
  <Oid>sample string 1</Oid>
  <Received>2024-05-15T00:21:14.5492607-04:00</Received>
  <Reconciled>2024-05-15T00:21:14.5492607-04:00</Reconciled>
  <ShipmentName>sample string 3</ShipmentName>
  <ShipmentNumber>2</ShipmentNumber>
  <ShipmentType>
    <Description>sample string 2</Description>
    <Name>sample string 1</Name>
    <Oid>sample string 3</Oid>
  </ShipmentType>
  <Shipped>2024-05-15T00:21:14.5492607-04:00</Shipped>
  <ToLocation>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <Campus>sample string 4</Campus>
    <CartNumber>sample string 18</CartNumber>
    <Category>
      <Description>sample string 2</Description>
      <Name>sample string 1</Name>
      <Oid>sample string 3</Oid>
    </Category>
    <City>sample string 5</City>
    <Country>sample string 6</Country>
    <CountryCode>sample string 7</CountryCode>
    <CustomFieldList>
      <CustomFieldDTO>
        <CustomFieldCaption>sample string 3</CustomFieldCaption>
        <CustomFieldExternalLabel>sample string 4</CustomFieldExternalLabel>
        <CustomFieldExternalReferenceName>sample string 5</CustomFieldExternalReferenceName>
        <CustomFieldName>sample string 2</CustomFieldName>
        <CustomFieldValue>sample string 6</CustomFieldValue>
        <Oid>sample string 1</Oid>
      </CustomFieldDTO>
      <CustomFieldDTO>
        <CustomFieldCaption>sample string 3</CustomFieldCaption>
        <CustomFieldExternalLabel>sample string 4</CustomFieldExternalLabel>
        <CustomFieldExternalReferenceName>sample string 5</CustomFieldExternalReferenceName>
        <CustomFieldName>sample string 2</CustomFieldName>
        <CustomFieldValue>sample string 6</CustomFieldValue>
        <Oid>sample string 1</Oid>
      </CustomFieldDTO>
    </CustomFieldList>
    <Customers>
      <BaseDTO>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Oid>sample string 3</Oid>
      </BaseDTO>
      <BaseDTO>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Oid>sample string 3</Oid>
      </BaseDTO>
    </Customers>
    <Floor>sample string 8</Floor>
    <FullName>sample string 9</FullName>
    <IsDefault>true</IsDefault>
    <LocationAdditionalDetails>sample string 20</LocationAdditionalDetails>
    <LocationId>dd12cd5b-a41a-40f1-8159-3741704db5b7</LocationId>
    <LocationType>
      <Description>sample string 2</Description>
      <Name>sample string 1</Name>
      <Oid>sample string 3</Oid>
    </LocationType>
    <LockedAndSecuredComments>sample string 21</LockedAndSecuredComments>
    <Name>sample string 11</Name>
    <Number>sample string 12</Number>
    <Oid>sample string 1</Oid>
    <PostalCode>sample string 13</PostalCode>
    <Region>sample string 14</Region>
    <RequestedDateTime>sample string 19</RequestedDateTime>
    <Room>sample string 15</Room>
    <State>sample string 16</State>
    <StateCode>sample string 17</StateCode>
    <Status>sample string 23</Status>
  </ToLocation>
  <TrackingNumber>sample string 9</TrackingNumber>
</ExternalShipmentDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The .

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.