inventory purchaseorder (http://api.3plcentral.com/rels/inventory/purchaseorder)
Resource:
expectation of receipt of items
C# Rel Const:
Rels.InventorySvc.PurchaseOrder
URI template:
pos/{id}
Obtain URI from:
Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int
Type Description
ReadOnly Inventory.Models.PurchaseOrderReadOnly
PurchaseOrderId int
CreationDate DateTime
LastModifiedDate DateTime
Closed bool
PurchaseOrderNumber string
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
IssueDate DateTime? ...
Supplier Generic.Models.ContactInfo in GETs: the contact; in POSTs or PUTs: identifies existing contact or properties of new contact
ContactId int? ... for identifying: if known specify only this; other fields are ignored
CompanyName string
Name string
Title string
Address1 string
Address2 string
City string
State string
Zip string
Country string
PhoneNumber string
Fax string
EmailAddress string
Dept string
IsAddressResidential bool
Code string for identifying: if known specify only this; if other fields also specified it is not used to identify
AddressStatus Common.Enum.AddressStatusType confirmation status
- 0: Unconfirmed
- 1: Confirmed
- 2: UserAccepted
Notes string
ExternalId string
LineItems IEnumerable<Inventory.Models.PurchaseOrderLineItem>
PurchaseOrderLineItemId int
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string
Quantity decimal
ExpectedFacility Generic.Models.FacilityIdentifier
Name string
Id int
ExpectedDate DateTime? ...
CancelDate DateTime? ...
Notes string
ExternalLineId string
Price decimal? ...
Sample accept: application/hal+json
{
  "readOnly": {
    "purchaseOrderId": 1,
    "creationDate": "2016-12-25T23:00:00",
    "lastModifiedDate": "2016-12-25T23:00:00",
    "closed": true
  },
  "purchaseOrderNumber": "str",
  "customerIdentifier": {
    "externalId": "str",
    "name": "str",
    "id": 3
  },
  "issueDate": "2016-12-25T23:00:00",
  "supplier": {
    "contactId": 1,
    "companyName": "str",
    "name": "str",
    "title": "str",
    "address1": "str",
    "address2": "str",
    "city": "str",
    "state": "str",
    "zip": "str",
    "country": "str",
    "phoneNumber": "str",
    "fax": "str",
    "emailAddress": "str",
    "dept": "str",
    "isAddressResidential": true,
    "code": "str",
    "addressStatus": 0
  },
  "notes": "str",
  "externalId": "str",
  "lineItems": [
    {
      "purchaseOrderLineItemId": 1,
      "itemIdentifier": {
        "sku": "str",
        "id": 2
      },
      "qualifier": "str",
      "quantity": 3.0,
      "expectedFacility": {
        "name": "str",
        "id": 2
      },
      "expectedDate": "2016-12-25T23:00:00",
      "cancelDate": "2016-12-25T23:00:00",
      "notes": "str",
      "externalLineId": "str",
      "price": 1.0
    }
  ]
}
Update an existing purchase order
If-Match request header required; Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int purchase order id
Type Description
ReadOnly Inventory.Models.PurchaseOrderReadOnly
PurchaseOrderId int
CreationDate DateTime
LastModifiedDate DateTime
Closed bool
PurchaseOrderNumber string
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
IssueDate DateTime? ...
Supplier Generic.Models.ContactInfo in GETs: the contact; in POSTs or PUTs: identifies existing contact or properties of new contact
ContactId int? ... for identifying: if known specify only this; other fields are ignored
CompanyName string
Name string
Title string
Address1 string
Address2 string
City string
State string
Zip string
Country string
PhoneNumber string
Fax string
EmailAddress string
Dept string
IsAddressResidential bool
Code string for identifying: if known specify only this; if other fields also specified it is not used to identify
AddressStatus Common.Enum.AddressStatusType confirmation status
- 0: Unconfirmed
- 1: Confirmed
- 2: UserAccepted
Notes string
ExternalId string
LineItems IEnumerable<Inventory.Models.PurchaseOrderLineItem>
PurchaseOrderLineItemId int
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string
Quantity decimal
ExpectedFacility Generic.Models.FacilityIdentifier
Name string
Id int
ExpectedDate DateTime? ...
CancelDate DateTime? ...
Notes string
ExternalLineId string
Price decimal? ...
Sample content-type: application/hal+json
{
  "readOnly": {
    "purchaseOrderId": 1,
    "creationDate": "2016-12-25T23:00:00",
    "lastModifiedDate": "2016-12-25T23:00:00",
    "closed": true
  },
  "purchaseOrderNumber": "str",
  "customerIdentifier": {
    "externalId": "str",
    "name": "str",
    "id": 3
  },
  "issueDate": "2016-12-25T23:00:00",
  "supplier": {
    "contactId": 1,
    "companyName": "str",
    "name": "str",
    "title": "str",
    "address1": "str",
    "address2": "str",
    "city": "str",
    "state": "str",
    "zip": "str",
    "country": "str",
    "phoneNumber": "str",
    "fax": "str",
    "emailAddress": "str",
    "dept": "str",
    "isAddressResidential": true,
    "code": "str",
    "addressStatus": 0
  },
  "notes": "str",
  "externalId": "str",
  "lineItems": [
    {
      "purchaseOrderLineItemId": 1,
      "itemIdentifier": {
        "sku": "str",
        "id": 2
      },
      "qualifier": "str",
      "quantity": 3.0,
      "expectedFacility": {
        "name": "str",
        "id": 2
      },
      "expectedDate": "2016-12-25T23:00:00",
      "cancelDate": "2016-12-25T23:00:00",
      "notes": "str",
      "externalLineId": "str",
      "price": 1.0
    }
  ]
}
Type Description
ReadOnly Inventory.Models.PurchaseOrderReadOnly
PurchaseOrderId int
CreationDate DateTime
LastModifiedDate DateTime
Closed bool
PurchaseOrderNumber string
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
IssueDate DateTime? ...
Supplier Generic.Models.ContactInfo in GETs: the contact; in POSTs or PUTs: identifies existing contact or properties of new contact
ContactId int? ... for identifying: if known specify only this; other fields are ignored
CompanyName string
Name string
Title string
Address1 string
Address2 string
City string
State string
Zip string
Country string
PhoneNumber string
Fax string
EmailAddress string
Dept string
IsAddressResidential bool
Code string for identifying: if known specify only this; if other fields also specified it is not used to identify
AddressStatus Common.Enum.AddressStatusType confirmation status
- 0: Unconfirmed
- 1: Confirmed
- 2: UserAccepted
Notes string
ExternalId string
LineItems IEnumerable<Inventory.Models.PurchaseOrderLineItem>
PurchaseOrderLineItemId int
ItemIdentifier Generic.Models.ItemIdentifier
Sku string
Id int
Qualifier string
Quantity decimal
ExpectedFacility Generic.Models.FacilityIdentifier
Name string
Id int
ExpectedDate DateTime? ...
CancelDate DateTime? ...
Notes string
ExternalLineId string
Price decimal? ...
Sample accept: application/hal+json
{
  "readOnly": {
    "purchaseOrderId": 1,
    "creationDate": "2016-12-25T23:00:00",
    "lastModifiedDate": "2016-12-25T23:00:00",
    "closed": true
  },
  "purchaseOrderNumber": "str",
  "customerIdentifier": {
    "externalId": "str",
    "name": "str",
    "id": 3
  },
  "issueDate": "2016-12-25T23:00:00",
  "supplier": {
    "contactId": 1,
    "companyName": "str",
    "name": "str",
    "title": "str",
    "address1": "str",
    "address2": "str",
    "city": "str",
    "state": "str",
    "zip": "str",
    "country": "str",
    "phoneNumber": "str",
    "fax": "str",
    "emailAddress": "str",
    "dept": "str",
    "isAddressResidential": true,
    "code": "str",
    "addressStatus": 0
  },
  "notes": "str",
  "externalId": "str",
  "lineItems": [
    {
      "purchaseOrderLineItemId": 1,
      "itemIdentifier": {
        "sku": "str",
        "id": 2
      },
      "qualifier": "str",
      "quantity": 3.0,
      "expectedFacility": {
        "name": "str",
        "id": 2
      },
      "expectedDate": "2016-12-25T23:00:00",
      "cancelDate": "2016-12-25T23:00:00",
      "notes": "str",
      "externalLineId": "str",
      "price": 1.0
    }
  ]
}
close a purchase order
fails if any open receivers refer to the purchase order
If-Match request header required; Success status: 204
Name (* = required) Data Type Description
id * int

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.