GET v1/ShopOwners/{shopOwnerId}/PurchaseOrders/{purchaseOrderCode}

Get detailed information about a Purchase Order.

Request Information

Requires Authorization!

URI Parameters

NameDescriptionTypeAdditional information
shopOwnerId

The id of the shopowner.

integer

Required.

purchaseOrderCode

The unique ShopCtrl Purchase Order code.

string

Required.

Body Parameters

None.

Response Information

Resource Description

The Order object.


PurchaseOrder
NameDescriptionTypeAdditional information
HandoverTimestamp

date

None.

ProvisionDate

date

None.

DateReceived

date

None.

MainStatus

Gets or sets the main status.

PurchaseOrderStatus

None.

SubmitStatus

Gets or sets the submit status.

PurchaseOrderStatus

None.

ProvisionStatus

Gets or sets the Provision status.

PurchaseOrderStatus

None.

PaymentStatus

PurchaseOrderStatus

None.

CustomStatus

Gets or sets the custom status.

PurchaseOrderStatus

None.

ExchangeRate

Gets or sets the exchange rate.

decimal number

Required

ShopOwnerId

Gets or sets the shopowner identifier.

integer

Required

OurReference

Gets or sets Our Reference.

string

Max length: 50

Comment

string

Max length: 2147483647

ShippingCostsExVat

Gets or sets the shipping costs (exclude VAT).

decimal number

Required

SupplierId

Gets or sets the Supplier identifier.

integer

Required

SupplierNote

Gets or sets the additional note to the Supplier.

string

Max length: 2147483647

BillToContact

Gets or sets the bill to contact.

ContactInfo

None.

ShipToContact

Gets or sets the ship to contact.

ContactInfo

None.

PurchaseOrderRows

Gets or sets the purchaseOrder rows.

Collection of PurchaseOrderRow

None.

WarehouseId

integer

None.

OrderId

integer

None.

FileId

integer

None.

Deliveries

Collection of DeliveryDto

None.

ExpectedDeliveryDate

date

None.

Id

Gets or sets the identifier.

integer

Required

OrderCode

Gets or sets the Purchase Order code.

string

Required

Max length: 50

Date

Gets or sets the date.

date

Required

OrderTotalExVat

Gets or sets the purchaseOrder total without the 'VAT'.

decimal number

Required

CurrencyId

Gets or sets the currency identifier.

integer

Required

CurrencyCode

Gets or sets the currency code.

string

None.

DeletedTimestamp

Gets or sets a value indicating whether this is deleted.

date

None.

ChangeTimestamp

Gets or sets the change timestamp.

date

None.

MainStatusId

Gets or sets the main status identifier.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "HandoverTimestamp": "2021-12-02T20:19:27.9353555+01:00",
  "ProvisionDate": "2021-12-02T20:19:27.9353555+01:00",
  "DateReceived": "2021-12-02T20:19:27.9353555+01:00",
  "MainStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2021-12-02T20:19:27.9353555+01:00",
    "Id": 2,
    "BasePurchaseOrderStatusId": 3,
    "PurchaseOrderStatusTypeId": 4,
    "Name": "sample string 5"
  },
  "SubmitStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2021-12-02T20:19:27.9353555+01:00",
    "Id": 2,
    "BasePurchaseOrderStatusId": 3,
    "PurchaseOrderStatusTypeId": 4,
    "Name": "sample string 5"
  },
  "ProvisionStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2021-12-02T20:19:27.9353555+01:00",
    "Id": 2,
    "BasePurchaseOrderStatusId": 3,
    "PurchaseOrderStatusTypeId": 4,
    "Name": "sample string 5"
  },
  "PaymentStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2021-12-02T20:19:27.9353555+01:00",
    "Id": 2,
    "BasePurchaseOrderStatusId": 3,
    "PurchaseOrderStatusTypeId": 4,
    "Name": "sample string 5"
  },
  "CustomStatus": {
    "Comment": "sample string 1",
    "ActionDate": "2021-12-02T20:19:27.9353555+01:00",
    "Id": 2,
    "BasePurchaseOrderStatusId": 3,
    "PurchaseOrderStatusTypeId": 4,
    "Name": "sample string 5"
  },
  "ExchangeRate": 1.0,
  "ShopOwnerId": 2,
  "OurReference": "sample string 3",
  "Comment": "sample string 4",
  "ShippingCostsExVat": 5.0,
  "SupplierId": 6,
  "SupplierNote": "sample string 7",
  "BillToContact": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2021-12-02T20:19:27.9353555+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "ShipToContact": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2021-12-02T20:19:27.9353555+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "PurchaseOrderRows": [
    {
      "Id": 1,
      "ProductId": 1,
      "ItemQuantity": 2.0,
      "ItemQuantityDelivered": 3.0,
      "ProductName": "sample string 4",
      "ProductCode": "sample string 5",
      "ProductDescription": "sample string 6",
      "ItemPriceExVat": 7.0,
      "RowTotalExVat": 8.0,
      "Comment": "sample string 9",
      "Sequence": 1,
      "ExpectedDeliveryDate": "2021-12-02T20:19:27.9353555+01:00"
    },
    {
      "Id": 1,
      "ProductId": 1,
      "ItemQuantity": 2.0,
      "ItemQuantityDelivered": 3.0,
      "ProductName": "sample string 4",
      "ProductCode": "sample string 5",
      "ProductDescription": "sample string 6",
      "ItemPriceExVat": 7.0,
      "RowTotalExVat": 8.0,
      "Comment": "sample string 9",
      "Sequence": 1,
      "ExpectedDeliveryDate": "2021-12-02T20:19:27.9353555+01:00"
    }
  ],
  "WarehouseId": 8,
  "OrderId": 1,
  "FileId": 1,
  "Deliveries": [
    {
      "UniqueId": "sample string 1",
      "DeliveryId": 2,
      "Comment": "sample string 3",
      "ExpectedDeliveryDate": "2021-12-02T20:19:27.9353555+01:00",
      "ProvisionDate": "2021-12-02T20:19:27.9353555+01:00",
      "ProvisionedBy": "sample string 5",
      "Lines": [
        {
          "PurchaseOrderRowId": 1,
          "SupplierSku": "sample string 2",
          "ProductCode": "sample string 3",
          "ProductName": "sample string 4",
          "Location": "sample string 5",
          "QtyExpected": 6,
          "QtyDelivered": 1
        },
        {
          "PurchaseOrderRowId": 1,
          "SupplierSku": "sample string 2",
          "ProductCode": "sample string 3",
          "ProductName": "sample string 4",
          "Location": "sample string 5",
          "QtyExpected": 6,
          "QtyDelivered": 1
        }
      ],
      "ProvisionStatusName": "sample string 6"
    },
    {
      "UniqueId": "sample string 1",
      "DeliveryId": 2,
      "Comment": "sample string 3",
      "ExpectedDeliveryDate": "2021-12-02T20:19:27.9353555+01:00",
      "ProvisionDate": "2021-12-02T20:19:27.9353555+01:00",
      "ProvisionedBy": "sample string 5",
      "Lines": [
        {
          "PurchaseOrderRowId": 1,
          "SupplierSku": "sample string 2",
          "ProductCode": "sample string 3",
          "ProductName": "sample string 4",
          "Location": "sample string 5",
          "QtyExpected": 6,
          "QtyDelivered": 1
        },
        {
          "PurchaseOrderRowId": 1,
          "SupplierSku": "sample string 2",
          "ProductCode": "sample string 3",
          "ProductName": "sample string 4",
          "Location": "sample string 5",
          "QtyExpected": 6,
          "QtyDelivered": 1
        }
      ],
      "ProvisionStatusName": "sample string 6"
    }
  ],
  "ExpectedDeliveryDate": "2021-12-02T20:19:27.9353555+01:00",
  "Id": 9,
  "OrderCode": "sample string 10",
  "Date": "2021-12-02T20:19:27.9353555+01:00",
  "OrderTotalExVat": 12.0,
  "CurrencyId": 13,
  "CurrencyCode": "sample string 14",
  "DeletedTimestamp": "2021-12-02T20:19:27.9353555+01:00",
  "ChangeTimestamp": "2021-12-02T20:19:27.9353555+01:00",
  "MainStatusId": 1
}

application/xml, text/xml

Sample:
<PurchaseOrder xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>9</Id>
  <OrderCode>sample string 10</OrderCode>
  <Date>2021-12-02T20:19:27.9353555+01:00</Date>
  <OrderTotalExVat>12</OrderTotalExVat>
  <CurrencyId>13</CurrencyId>
  <CurrencyCode>sample string 14</CurrencyCode>
  <DeletedTimestamp>2021-12-02T20:19:27.9353555+01:00</DeletedTimestamp>
  <ChangeTimestamp>2021-12-02T20:19:27.9353555+01:00</ChangeTimestamp>
  <MainStatusId>1</MainStatusId>
  <HandoverTimestamp>2021-12-02T20:19:27.9353555+01:00</HandoverTimestamp>
  <ProvisionDate>2021-12-02T20:19:27.9353555+01:00</ProvisionDate>
  <DateReceived>2021-12-02T20:19:27.9353555+01:00</DateReceived>
  <MainStatus>
    <Id>2</Id>
    <BasePurchaseOrderStatusId>3</BasePurchaseOrderStatusId>
    <PurchaseOrderStatusTypeId>4</PurchaseOrderStatusTypeId>
    <Name>sample string 5</Name>
    <Comment>sample string 1</Comment>
    <ActionDate>2021-12-02T20:19:27.9353555+01:00</ActionDate>
  </MainStatus>
  <SubmitStatus>
    <Id>2</Id>
    <BasePurchaseOrderStatusId>3</BasePurchaseOrderStatusId>
    <PurchaseOrderStatusTypeId>4</PurchaseOrderStatusTypeId>
    <Name>sample string 5</Name>
    <Comment>sample string 1</Comment>
    <ActionDate>2021-12-02T20:19:27.9353555+01:00</ActionDate>
  </SubmitStatus>
  <ProvisionStatus>
    <Id>2</Id>
    <BasePurchaseOrderStatusId>3</BasePurchaseOrderStatusId>
    <PurchaseOrderStatusTypeId>4</PurchaseOrderStatusTypeId>
    <Name>sample string 5</Name>
    <Comment>sample string 1</Comment>
    <ActionDate>2021-12-02T20:19:27.9353555+01:00</ActionDate>
  </ProvisionStatus>
  <PaymentStatus>
    <Id>2</Id>
    <BasePurchaseOrderStatusId>3</BasePurchaseOrderStatusId>
    <PurchaseOrderStatusTypeId>4</PurchaseOrderStatusTypeId>
    <Name>sample string 5</Name>
    <Comment>sample string 1</Comment>
    <ActionDate>2021-12-02T20:19:27.9353555+01:00</ActionDate>
  </PaymentStatus>
  <CustomStatus>
    <Id>2</Id>
    <BasePurchaseOrderStatusId>3</BasePurchaseOrderStatusId>
    <PurchaseOrderStatusTypeId>4</PurchaseOrderStatusTypeId>
    <Name>sample string 5</Name>
    <Comment>sample string 1</Comment>
    <ActionDate>2021-12-02T20:19:27.9353555+01:00</ActionDate>
  </CustomStatus>
  <ExchangeRate>1</ExchangeRate>
  <ShopOwnerId>2</ShopOwnerId>
  <OurReference>sample string 3</OurReference>
  <Comment>sample string 4</Comment>
  <ShippingCostsExVat>5</ShippingCostsExVat>
  <SupplierId>6</SupplierId>
  <SupplierNote>sample string 7</SupplierNote>
  <BillToContact>
    <Id>9</Id>
    <CompanyName>sample string 10</CompanyName>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <StreetAddress>sample string 13</StreetAddress>
    <StreetAddressNumber>sample string 14</StreetAddressNumber>
    <StreetAddressExtension>sample string 15</StreetAddressExtension>
    <PostalCode>sample string 16</PostalCode>
    <City>sample string 17</City>
    <CountryId>1</CountryId>
    <CountryCode>sample string 18</CountryCode>
    <EMail>sample string 19</EMail>
    <Phone>sample string 20</Phone>
    <Phone2>sample string 21</Phone2>
    <StateProvince>sample string 22</StateProvince>
    <StateProvinceCode>sample string 23</StateProvinceCode>
    <VatNumber>sample string 1</VatNumber>
    <FullName>sample string 2</FullName>
    <DateOfBirth>2021-12-02T20:19:27.9353555+01:00</DateOfBirth>
    <Gender>sample string 3</Gender>
    <PersonTitle>sample string 4</PersonTitle>
    <MiddleName>sample string 5</MiddleName>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <LastNamePrefix>sample string 8</LastNamePrefix>
  </BillToContact>
  <ShipToContact>
    <Id>9</Id>
    <CompanyName>sample string 10</CompanyName>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <StreetAddress>sample string 13</StreetAddress>
    <StreetAddressNumber>sample string 14</StreetAddressNumber>
    <StreetAddressExtension>sample string 15</StreetAddressExtension>
    <PostalCode>sample string 16</PostalCode>
    <City>sample string 17</City>
    <CountryId>1</CountryId>
    <CountryCode>sample string 18</CountryCode>
    <EMail>sample string 19</EMail>
    <Phone>sample string 20</Phone>
    <Phone2>sample string 21</Phone2>
    <StateProvince>sample string 22</StateProvince>
    <StateProvinceCode>sample string 23</StateProvinceCode>
    <VatNumber>sample string 1</VatNumber>
    <FullName>sample string 2</FullName>
    <DateOfBirth>2021-12-02T20:19:27.9353555+01:00</DateOfBirth>
    <Gender>sample string 3</Gender>
    <PersonTitle>sample string 4</PersonTitle>
    <MiddleName>sample string 5</MiddleName>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <LastNamePrefix>sample string 8</LastNamePrefix>
  </ShipToContact>
  <PurchaseOrderRows>
    <PurchaseOrderRow>
      <Id>1</Id>
      <ProductId>1</ProductId>
      <ItemQuantity>2</ItemQuantity>
      <ItemQuantityDelivered>3</ItemQuantityDelivered>
      <ProductName>sample string 4</ProductName>
      <ProductCode>sample string 5</ProductCode>
      <ProductDescription>sample string 6</ProductDescription>
      <ItemPriceExVat>7</ItemPriceExVat>
      <RowTotalExVat>8</RowTotalExVat>
      <Comment>sample string 9</Comment>
      <Sequence>1</Sequence>
      <ExpectedDeliveryDate>2021-12-02T20:19:27.9353555+01:00</ExpectedDeliveryDate>
    </PurchaseOrderRow>
    <PurchaseOrderRow>
      <Id>1</Id>
      <ProductId>1</ProductId>
      <ItemQuantity>2</ItemQuantity>
      <ItemQuantityDelivered>3</ItemQuantityDelivered>
      <ProductName>sample string 4</ProductName>
      <ProductCode>sample string 5</ProductCode>
      <ProductDescription>sample string 6</ProductDescription>
      <ItemPriceExVat>7</ItemPriceExVat>
      <RowTotalExVat>8</RowTotalExVat>
      <Comment>sample string 9</Comment>
      <Sequence>1</Sequence>
      <ExpectedDeliveryDate>2021-12-02T20:19:27.9353555+01:00</ExpectedDeliveryDate>
    </PurchaseOrderRow>
  </PurchaseOrderRows>
  <WarehouseId>8</WarehouseId>
  <OrderId>1</OrderId>
  <FileId>1</FileId>
  <Deliveries>
    <Delivery>
      <UniqueId>sample string 1</UniqueId>
      <DeliveryId>2</DeliveryId>
      <Comment>sample string 3</Comment>
      <ExpectedDeliveryDate>2021-12-02T20:19:27.9353555+01:00</ExpectedDeliveryDate>
      <ProvisionDate>2021-12-02T20:19:27.9353555+01:00</ProvisionDate>
      <ProvisionedBy>sample string 5</ProvisionedBy>
      <Lines>
        <DeliveryLineDto>
          <PurchaseOrderRowId>1</PurchaseOrderRowId>
          <SupplierSku>sample string 2</SupplierSku>
          <ProductCode>sample string 3</ProductCode>
          <ProductName>sample string 4</ProductName>
          <Location>sample string 5</Location>
          <QtyExpected>6</QtyExpected>
          <QtyDelivered>1</QtyDelivered>
        </DeliveryLineDto>
        <DeliveryLineDto>
          <PurchaseOrderRowId>1</PurchaseOrderRowId>
          <SupplierSku>sample string 2</SupplierSku>
          <ProductCode>sample string 3</ProductCode>
          <ProductName>sample string 4</ProductName>
          <Location>sample string 5</Location>
          <QtyExpected>6</QtyExpected>
          <QtyDelivered>1</QtyDelivered>
        </DeliveryLineDto>
      </Lines>
      <ProvisionStatusName>sample string 6</ProvisionStatusName>
      <CanProvision>true</CanProvision>
      <CanDelete>true</CanDelete>
      <CanEdit>true</CanEdit>
    </Delivery>
    <Delivery>
      <UniqueId>sample string 1</UniqueId>
      <DeliveryId>2</DeliveryId>
      <Comment>sample string 3</Comment>
      <ExpectedDeliveryDate>2021-12-02T20:19:27.9353555+01:00</ExpectedDeliveryDate>
      <ProvisionDate>2021-12-02T20:19:27.9353555+01:00</ProvisionDate>
      <ProvisionedBy>sample string 5</ProvisionedBy>
      <Lines>
        <DeliveryLineDto>
          <PurchaseOrderRowId>1</PurchaseOrderRowId>
          <SupplierSku>sample string 2</SupplierSku>
          <ProductCode>sample string 3</ProductCode>
          <ProductName>sample string 4</ProductName>
          <Location>sample string 5</Location>
          <QtyExpected>6</QtyExpected>
          <QtyDelivered>1</QtyDelivered>
        </DeliveryLineDto>
        <DeliveryLineDto>
          <PurchaseOrderRowId>1</PurchaseOrderRowId>
          <SupplierSku>sample string 2</SupplierSku>
          <ProductCode>sample string 3</ProductCode>
          <ProductName>sample string 4</ProductName>
          <Location>sample string 5</Location>
          <QtyExpected>6</QtyExpected>
          <QtyDelivered>1</QtyDelivered>
        </DeliveryLineDto>
      </Lines>
      <ProvisionStatusName>sample string 6</ProvisionStatusName>
      <CanProvision>true</CanProvision>
      <CanDelete>true</CanDelete>
      <CanEdit>true</CanEdit>
    </Delivery>
  </Deliveries>
  <ExpectedDeliveryDate>2021-12-02T20:19:27.9353555+01:00</ExpectedDeliveryDate>
</PurchaseOrder>