POST api/rep/CreatePickupNote

Creates a new Pickup Note

Request Information

URI Parameters

None.

Body Parameters

The Pickup Note object to store

Name	Type	Additional information
PickupNoteID	integer	None.
CustomerID	string	None.
Customer	string	None.
ReasonForReturn	string	None.
DateCreated	date	None.
Products	Collection of PickupNoteProduct	None.

Request Formats

application/json, text/json

Sample:

{
  "PickupNoteID": 1,
  "CustomerID": "sample string 2",
  "Customer": "sample string 3",
  "ReasonForReturn": "sample string 4",
  "DateCreated": "2026-07-17T15:04:46.4373156+02:00",
  "Products": [
    {
      "PickupNoteProductID": 1,
      "PickupNoteID": 2,
      "ItemCode": "sample string 3",
      "ProductDescription": "sample string 4",
      "BatchNumber": "sample string 5",
      "YarnColours": "sample string 6",
      "ExpiryDate": "2026-07-17T15:04:46.4373156+02:00",
      "QTY": 8,
      "UnitPrice": 9.0,
      "Amount": 10.0
    },
    {
      "PickupNoteProductID": 1,
      "PickupNoteID": 2,
      "ItemCode": "sample string 3",
      "ProductDescription": "sample string 4",
      "BatchNumber": "sample string 5",
      "YarnColours": "sample string 6",
      "ExpiryDate": "2026-07-17T15:04:46.4373156+02:00",
      "QTY": 8,
      "UnitPrice": 9.0,
      "Amount": 10.0
    }
  ]
}

application/xml, text/xml

Sample:

<PickupNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Core.Models.RepApp">
  <Customer>sample string 3</Customer>
  <CustomerID>sample string 2</CustomerID>
  <DateCreated>2026-07-17T15:04:46.4373156+02:00</DateCreated>
  <PickupNoteID>1</PickupNoteID>
  <Products>
    <PickupNoteProduct>
      <Amount>10</Amount>
      <BatchNumber>sample string 5</BatchNumber>
      <ExpiryDate>2026-07-17T15:04:46.4373156+02:00</ExpiryDate>
      <ItemCode>sample string 3</ItemCode>
      <PickupNoteID>2</PickupNoteID>
      <PickupNoteProductID>1</PickupNoteProductID>
      <ProductDescription>sample string 4</ProductDescription>
      <QTY>8</QTY>
      <UnitPrice>9</UnitPrice>
      <YarnColours>sample string 6</YarnColours>
    </PickupNoteProduct>
    <PickupNoteProduct>
      <Amount>10</Amount>
      <BatchNumber>sample string 5</BatchNumber>
      <ExpiryDate>2026-07-17T15:04:46.4373156+02:00</ExpiryDate>
      <ItemCode>sample string 3</ItemCode>
      <PickupNoteID>2</PickupNoteID>
      <PickupNoteProductID>1</PickupNoteProductID>
      <ProductDescription>sample string 4</ProductDescription>
      <QTY>8</QTY>
      <UnitPrice>9</UnitPrice>
      <YarnColours>sample string 6</YarnColours>
    </PickupNoteProduct>
  </Products>
  <ReasonForReturn>sample string 4</ReasonForReturn>
</PickupNote>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the updated Pickup Note object containing the Pickup Note ID

PickupNoteViewModel

Name	Description	Type	Additional information
pickupNote		PickupNote	None.
apiResponse		APIResponseMessage	None.

Response Formats

application/json, text/json

Sample:

{
  "pickupNote": {
    "PickupNoteID": 1,
    "CustomerID": "sample string 2",
    "Customer": "sample string 3",
    "ReasonForReturn": "sample string 4",
    "DateCreated": "2026-07-17T15:04:46.6873179+02:00",
    "Products": [
      {
        "PickupNoteProductID": 1,
        "PickupNoteID": 2,
        "ItemCode": "sample string 3",
        "ProductDescription": "sample string 4",
        "BatchNumber": "sample string 5",
        "YarnColours": "sample string 6",
        "ExpiryDate": "2026-07-17T15:04:46.6873179+02:00",
        "QTY": 8,
        "UnitPrice": 9.0,
        "Amount": 10.0
      },
      {
        "PickupNoteProductID": 1,
        "PickupNoteID": 2,
        "ItemCode": "sample string 3",
        "ProductDescription": "sample string 4",
        "BatchNumber": "sample string 5",
        "YarnColours": "sample string 6",
        "ExpiryDate": "2026-07-17T15:04:46.6873179+02:00",
        "QTY": 8,
        "UnitPrice": 9.0,
        "Amount": 10.0
      }
    ]
  },
  "apiResponse": {
    "HttpStatusCode": "sample string 1",
    "ReasonPhrase": "sample string 2",
    "ExceptionMessage": "sample string 3",
    "GeneralMessage": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<PickupNoteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Rep">
  <apiResponse xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.Core.Models">
    <d2p1:ExceptionMessage>sample string 3</d2p1:ExceptionMessage>
    <d2p1:GeneralMessage>sample string 4</d2p1:GeneralMessage>
    <d2p1:HttpStatusCode>sample string 1</d2p1:HttpStatusCode>
    <d2p1:ReasonPhrase>sample string 2</d2p1:ReasonPhrase>
  </apiResponse>
  <pickupNote xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.Core.Models.RepApp">
    <d2p1:Customer>sample string 3</d2p1:Customer>
    <d2p1:CustomerID>sample string 2</d2p1:CustomerID>
    <d2p1:DateCreated>2026-07-17T15:04:46.6873179+02:00</d2p1:DateCreated>
    <d2p1:PickupNoteID>1</d2p1:PickupNoteID>
    <d2p1:Products>
      <d2p1:PickupNoteProduct>
        <d2p1:Amount>10</d2p1:Amount>
        <d2p1:BatchNumber>sample string 5</d2p1:BatchNumber>
        <d2p1:ExpiryDate>2026-07-17T15:04:46.6873179+02:00</d2p1:ExpiryDate>
        <d2p1:ItemCode>sample string 3</d2p1:ItemCode>
        <d2p1:PickupNoteID>2</d2p1:PickupNoteID>
        <d2p1:PickupNoteProductID>1</d2p1:PickupNoteProductID>
        <d2p1:ProductDescription>sample string 4</d2p1:ProductDescription>
        <d2p1:QTY>8</d2p1:QTY>
        <d2p1:UnitPrice>9</d2p1:UnitPrice>
        <d2p1:YarnColours>sample string 6</d2p1:YarnColours>
      </d2p1:PickupNoteProduct>
      <d2p1:PickupNoteProduct>
        <d2p1:Amount>10</d2p1:Amount>
        <d2p1:BatchNumber>sample string 5</d2p1:BatchNumber>
        <d2p1:ExpiryDate>2026-07-17T15:04:46.6873179+02:00</d2p1:ExpiryDate>
        <d2p1:ItemCode>sample string 3</d2p1:ItemCode>
        <d2p1:PickupNoteID>2</d2p1:PickupNoteID>
        <d2p1:PickupNoteProductID>1</d2p1:PickupNoteProductID>
        <d2p1:ProductDescription>sample string 4</d2p1:ProductDescription>
        <d2p1:QTY>8</d2p1:QTY>
        <d2p1:UnitPrice>9</d2p1:UnitPrice>
        <d2p1:YarnColours>sample string 6</d2p1:YarnColours>
      </d2p1:PickupNoteProduct>
    </d2p1:Products>
    <d2p1:ReasonForReturn>sample string 4</d2p1:ReasonForReturn>
  </pickupNote>
</PickupNoteViewModel>