Current Version: 0.5.0
Production Base URL: https://api.premierwd.com/api/v5/
Test Base URL: http://api-test.premierwd.com/api/v5/
Recent Changes
Note: In an effort to make our API more consistent, align with terminology used throughout the industry, and adhere to API conventions, version 0.5.0 of our API includes the following changes:
New! Get Tracking by Date Range CLICK HERE
New! Specify Signature Required when Submitting Sales Orders CLICK HERE
ATTENTION: Small changes may have been made to return data on several of the requests.
Authenticate
The authenticate API returns a session token that is required to access any of the other APIs. APIs require an HTTP header of
Authorization
and a value of Bearer {session-token}
Please contact your regional rep to get an API key.
GET authenticate?apiKey={api-key}
Returns a Bearer token to be used with all other API requests. Include the Bearer token in the header of every API call.
Request:
https://api.premierwd.com/api/v5/authenticate?apiKey=11028fd0-9222-4437-ae3f-c1c59fc5cd55
Response:
{
"sessionToken":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwchovL2FwaS53ZXNwZWFrZGllc2VsLmNvbS9hcGkvYXV0aGVudG..."
}
Inventory
The inventory API returns our inventory counts in each of our warehouses for one or many items.
GET inventory?itemNumber={itemNumber}
Returns the inventory counts for the specified item.
Request:
https://api.premierwd.com/api/v5/inventory?itemNumber=AUT17203
Response:
{
"itemNumber": "AUT17203",
"inventory": [
{
"warehouseCode": "UT-1-US",
"quantityAvailable": 3
},
{
"warehouseCode": "KY-1-US",
"quantityAvailable": 9
},
{
"warehouseCode": "TX-1-US",
"quantityAvailable": 10
},
{
"warehouseCode": "CA-1-US",
"quantityAvailable": 2
},
{
"warehouseCode": "AB-1-CA",
"quantityAvailable": 0
},
{
"warehouseCode": "WA-1-US",
"quantityAvailable": 0
},
{
"warehouseCode": "CO-1-US",
"quantityAvailable": 0
}
]
}
GET inventory?itemNumbers={itemNumber},{itemNumber}
Returns the inventory counts for the specified items. Inventory may be requested for up to 50 items in one request.
Request
https://api.premierwd.com/api/v5/inventory?itemNumbers=AUT17203,AUT17204
Response
[
{
"itemNumber": "AUT17203",
"inventory": [
{
"warehouseCode": "UT-1-US",
"quantityAvailable": 5
},
{
"warehouseCode": "KY-1-US",
"quantityAvailable": 0
},
{
"warehouseCode": "TX-1-US",
"quantityAvailable": 1
},
{
"warehouseCode": "CA-1-US",
"quantityAvailable": 0
},
{
"warehouseCode": "AB-1-CA",
"quantityAvailable": 2
},
{
"warehouseCode": "WA-1-US",
"quantityAvailable": 0
},
{
"warehouseCode": "CO-1-US",
"quantityAvailable": 0
},
{
"warehouseCode": "PO-1-CA",
"quantityAvailable": 0
}
]
},
{
"itemNumber": "AUT17204",
"inventory": [
{
"warehouseCode": "UT-1-US",
"quantityAvailable": 4
},
{
"warehouseCode": "KY-1-US",
"quantityAvailable": 1
},
{
"warehouseCode": "TX-1-US",
"quantityAvailable": 1
},
{
"warehouseCode": "CA-1-US",
"quantityAvailable": 0
},
{
"warehouseCode": "AB-1-CA",
"quantityAvailable": 0
},
{
"warehouseCode": "WA-1-US",
"quantityAvailable": 0
},
{
"warehouseCode": "CO-1-US",
"quantityAvailable": 0
},
{
"warehouseCode": "PO-1-CA",
"quantityAvailable": 0
}
]
}
]
Pricing
The pricing API returns a customer's current pricing for all US (in US dollars) and Canadian (in Canadian dollars) warehouses for one or many items.
GET pricing?itemNumber={itemNumber}
Returns the USD & CAD pricing for the specified item.
Request:
https://api.premierwd.com/api/v5/pricing?itemNumber=AUT17203
Response:
{
"id": 44119,
"itemNumber": "AUT17203",
"pricing": [
{
"cost": 85.41,
"jobber": 85.41,
"map": 73.95,
"retail": 85.41,
"currency": "USD"
},
{
"cost": 111.033,
"jobber": 111.033,
"map": 96.135,
"retail": 111.033,
"currency": "CAD"
}
]
}
GET pricing?itemNumbers={itemNumber},{itemNumber}
Returns the USD & CAD pricing for the specified items. Pricing may be requested for up to 50 items in one request.
Request:
https://api.premierwd.com/api/v5/pricing?itemNumbers=AUT17203,AUT17204
Response:
[
{
"id": 44119,
"itemNumber": "AUT17203",
"pricing": [
{
"cost": 85.41,
"jobber": 85.41,
"map": 73.95,
"retail": 85.41,
"currency": "USD"
},
{
"cost": 111.033,
"jobber": 111.033,
"map": 96.135,
"retail": 111.033,
"currency": "CAD"
}
]
},
{
"id": 44118,
"itemNumber": "AUT17204",
"pricing": [
{
"cost": 83.02,
"jobber": 83.02,
"map": 78.95,
"retail": 83.02,
"currency": "USD"
},
{
"cost": 107.926,
"jobber": 107.926,
"map": 102.635,
"retail": 107.926,
"currency": "CAD"
}
]
}
]
Tracking
Returns tracking numbers and the associated items and quantity for a given date range, Premier sales order number, Premier invoice number, or customer's purchase order number.
or GET tracking/date?startDate={{yyyy-mm-dd}}&endDate={{yyyy-mm-dd}}
GET tracking/date?startDate={{yyyy-mm-dd}}
Returns all sales orders with the associated tracking, invoice, and purchase order number infomation within a date range. The date range can return a minimum result of 0 and a max of 1000 sales orders. If the sales order has no tracking numbers the tracking will be empty. If the sale order hase invoice information the invoice number will be included in the response.
Note:startDate
is required. If you exclude the endDate
the defualt end date will be today's date.
Request:
https://api.premierwd.com/api/v5/tracking/date?startDate=2016-11-01
Response:
[
{
"salesOrderNumber": "SO-0001234567",
"invoiceNumber": "0003333445435-IN",
"customerPurchaseOrderNumber": "123456789",
"tracking": [
{
"trackingNumber": "1ZR123E3243434334",
"carrier": "UPS",
"isDropShip": false,
"packageItems": [
{
"itemNumber": "HUS53211",
"quantity": 1
}
]
}
]
},
{
"salesOrderNumber": "SO-0003514561461",
"invoiceNumber": "00014651-IN",
"customerPurchaseOrderNumber": "11635146161",
"tracking": [
{
"trackingNumber": "32R2RR34RR44",
"carrier": "UPS",
"isDropShip": false,
"packageItems": [
{
"itemNumber": "ROY40-2051",
"quantity": 1
},
{
"itemNumber": "ROY40-2051",
"quantity": 2
}
]
},
{
"trackingNumber": "32R2RR3E4R244",
"carrier": "UPS",
"isDropShip": false,
"packageItems": [
{
"itemNumber": "ROY40-2051",
"quantity": 1
},
{
"itemNumber": "ROY40-2051",
"quantity": 4
}
]
}
]
},
{
"salesOrderNumber": "SO-00033854646",
"customerPurchaseOrderNumber": "123456782",
"tracking": []
}
]
GET tracking?salesOrderNumber={salesOrderNumber}
Returns the tracking numbers for the specified Premier sales order.
Request:
https://api.premierwd.com/api/v5/tracking?salesOrderNumber=0003675602
Response:
[
{
"trackingNumber": "32R2RR34RR44",
"carrier": "UPS",
"isDropShip": false,
"packageItems": [
{
"itemNumber": "AUT17203",
"quantity": 1
}
]
},
{
"trackingNumber": "3F4V34F43344",
"carrier": "UPS",
"isDropShip": false,
"packageItems": [
{
"itemNumber": "AUT17204",
"quantity": 1
}
]
}
]
GET tracking?invoiceNumber={invoiceNumber}
Returns the tracking numbers for the specified Premier invoice.
Request:
https://api.premierwd.com/api/v5/tracking?invoiceNumber=0003675602
Response:
[
{
"trackingNumber": "43534535DD5DD34534",
"carrier": "UPS",
"isDropShip": false,
"packageItems": [
{
"itemNumber": "MBRT5075",
"quantity": 1
}
]
},
{
"trackingNumber": "345345454CD5453443",
"carrier": "UPS",
"isDropShip": false,
"packageItems": [
{
"itemNumber": "AMP76154-01A",
"quantity": 1
}
]
}
]
GET tracking?purchaseOrderNumber={purchaseOrderNumber}
Returns the tracking numbers for the specified customer purchase order number.
Request:
https://api.premierwd.com/api/v5/tracking?purchaseOrderNumber=90635
Response:
[
{
"trackingNumber": "1Z43543F34FR4",
"carrier": "UPS",
"isDropShip": false,
"packageItems": [
{
"itemNumber": "FASSTK-1002",
"quantity": 1
}
]
},
{
"trackingNumber": "1R343EWFSDF43",
"carrier": "UPS",
"isDropShip": true,
"packageItems": [
{
"itemNumber": "FASFL-1002",
"quantity": 20
},
{
"itemNumber": "DROPFEEFAS",
"quantity": 1
}
]
}
]
Sales Orders
POST sales-orders
Submits a sales order to premier.
Request:
https://api.premierwd.com/api/v5/sales-orders/
POST Data:
{
customerPurchaseOrderNumber : "CUSTOMER PO",
note: "Sales Order Note",
signatureRequired: true,
shipMethod: "UPS Next Day",
warehouseCode: "KY-1-US",
shipToAddress: {
name: "Test Address",
addressLine1: "278 E. Dividend Dr.",
addressLine2: "Suite 100",
city: "Rexburg",
regionCode: "ID",
postalCode: "83440",
countryCode: "US",
phone: "18884973666"
},
salesOrderLines: [
{
itemNumber: "AUT17203",
quantity: 1,
note: "Sales Order Line Note",
shipMethod: "GROUND",
warehouseCode: "CA-1-US"
}
]
};
Property | Applies To | Description | Restrictions |
---|---|---|---|
customerPurchaseOrderNumber | Sales Order | The customer's purchase order number to associate with this sales order | Optional string up to 50 characters. |
note | Sales Order, Sales Order Lines | Specify a note on the sales order or sales order lines | Optional string up to 50 characters on a sales order and 255 on a sales order line. |
signatureRequired | Sales Order | When marked as true package will require a signature upon delivery. | This is an optional field, if not marked it will default to false. |
shipMethod | Sales Order, Sales Order Lines | When specified on a sales order line the shipMethod specifies the ship method of that line. When specified on the sales order, the shipMethod serves as the default shipMethod for all lines that don't specify their own shipMethod. | This is an optional field, see Ship Methods List for valid values. |
warehouseCode | Sales Order, Sales Order Lines | When specified on a sales order line the warehouseCode specifies the warehouse from which that line should ship. When specified on the sales order, the warehouseCode serves as the default warehouse for all lines that don't specify their own warehouseCode. | This is an optional field, see Warehouse List for valid values. If the warehouse isn't specified either at the sales order or sales order line level, The best warehouse will be determined after submission. |
salesOrderLines | Sales Order | An array of sales order lines | At least one sales order line is required. |
itemNumber | Sales Order Line | The itemNumber of the item to order | Required string up to 30 characters |
quantity | Sales Order Line | The quantity of the specified item to order | Required number |
shipToAddress | Sales Order | The address to which the order should be shipped | Required |
name | Ship To Address | A name that describes the address | Optional string up to 35 characters |
addressLine1 | Ship To Address | Line 1 of the street address | Required string up to 35 characters |
addressLine2 | Ship To Address | Line 2 of the street address | Optional string up to 35 characters |
city | Ship To Address | The city of the address | Required string up to 20 characters |
regionCode | Ship To Address | The two-digit state or province code | Required string of two characters |
postalCode | Ship To Address | The postal code of the address | Required string between 5 to 10 characters |
countryCode | Ship To Address | The two-digit country code | Required string of two characters |
phone | Ship To Address | The phone number of the contact | Required string between 10 to 17 digits |
Response:
{
customerPurchaseOrderNumber : "CUSTOMER PO",
note: "Sales Order Note",
salesOrderLines: [
{
itemNumber: "AUT17203",
quantity: 1,
note: "Sales Order Line Note",
shipMethod: "UPS Ground",
isDropship: true,
warehouseCode: "CA-1-US"
}
],
shipToAddress: {
name: "Test Address",
addressLine1: "278 E. Dividend Dr.",
addressLine2: "Suite 100",
city: "Rexburg",
regionCode: "ID",
postalCode: "83440",
countryCode: "US",
phone: "18884973666"
}
};
The format of the response will largely be the same as the sales order passed in with the following exceptions:
Notes:
- If specified, the warehouse and ship methods at the sales order level will be removed and the values will have been added to any sales order lines that did not specify warehouse and/or ship method values.
- Any sales order lines that did not specify a warehouse will have the auto-selected warehouse included.
- Any sales order lines that were dropshipped will include the isDropship="true" flag.
Out of Stock Preferences
If items are out of stock, the sales order API can automatically backorder or dropship those items. Likewise, customers that only want the orders that are in stock, can specify that any orders that would need to backorder or dropship should fail. Out of stock preferences on a per API user basis and are associated with your API key. Should you need to change your backorder or dropship preferences, please contact your Premier sales representative and indicate whether you want to allow backorders and dropships via the API.
Warehouse Fulfillment
If a warehouse is specified either as a default warehouse at the sales order level or on a sales order line, the order will be fulfilled from that warehouse. If the inventory is insufficient in that warehouse, the line will dropship or backorder or the sales order will fail depending on the out of stock preferences associated with the API account that is submitting the order.
Warehouse Auto-selection
If no warehouse is specified on a sales order line and there isn't a default warehouse specified on the order, the sales order API will try to fulfill it from the closest warehouse with inventory within the same country it is being shipped to. The API will not cause items to be shipped across international borders. If the inventory is insufficient in all domestic warehouses, the line will dropship or backorder or the sales order will fail depending on the out of stock preferences associated with the API account that is submitting the order.
Warehouse Code List
*Idaho Warehouse has been changed to Utah Warehouse. The api will still accept Idaho warehouse code but converts it to the Utah warehouse code.
Warehouse Code | Description |
---|---|
UT-1-US | Utah Warehouse |
KY-1-US | Kentucky Warehouse |
CA-1-US | California Warehouse |
TX-1-US | Texas Warehouse |
WA-1-US | Washington Warehouse |
CO-1-US | Colorado Warehouse |
AB-1-CA | Alberta Warehouse |
Ship Method List
Ship Method ID | Ship Method Description |
---|---|
GROUND | UPS Ground |
2ND DAY | UPS 2nd Day |
2ND DAY AM | UPS 2nd Day AM |
2ND DAY LETTER | UPS 2nd Day Letter |
3 DAY SELECT | UPS 3 Day Select |
FEDEX 2ND DAY | Fedex 2nd Day |
FEDEX 3 DAY | Fedex 3rd Day Delivery |
FEDEX GROUND | Fedex Ground |
FEDEX INT 1 DAY | FedEx Intnl Priority |
FEDEX INT 3 DAY | FedEx Intnl Economy Freight |
FEDEX PRIORITY | FEDEX Prty Overnight 10:30am |
FEDEX STD OVRNT | FEDEX Stnd Overnight 5:00pm |
NEXT DAY | UPS Next Day |
NEXT DAY AM | UPS Next Day Air Early AM |
NEXT DAY LETTER | UPS Next Day Letter |
NEXT DAY SAT | UPS Next Day Saturday |
NEXT DAY SAVER | UPS Next Day Saver |
ONTRAC | Ontrac |
P-UP | Customer Pick-Up |
Priority Mail | USPS Priority Mail 1-3 |
Express Mail | USPS Express Mail |
EXPRESS INT | UPS Express International |
PRIORITY INT | USPS PriorityInternational6-10 |
EXPEDITED INT | UPS Worldwide Expedited |
STANDARD INT | UPS Standard International |
EXPRESS INT PLS | UPS Worldwide Express Plus |
EXPRESS INT SVR | UPS Express Saver Int |
FIRST OVERNIGHT | FEDEX First Overnight |
EXPRESS SAVER | FEDEX Express Saver |
HOME DELIVERY | FEDEX Home Delivery |
PARCEL POST | USPS Parcel Post 2-8 |
Global Express | USPS Global Express1-3 |
Exp Mail Inter. | USPS Express Mail Internat.3-5 |
1st Class Int. | USPS 1st Class Internat Varies |
1st Class | USPS 1st Class 1-3 |
20101 | UPS Standard |
20501 | Pick-Up Canada |
20102 | UPS Express 1Day am CAN |
20103 | UPS Expedited 2day CAN |
20104 | UPSWorldwide 1-3dayCAN |
20105 | UPS WorldwideExpeditedCAN |
20106 | UPS 3 Day Select CAN |
20107 | UPS Express Saver CAN |
20108 | UPS Express AM CAN |
20109 | UPS Worldwide Plus CAN |
20201 | FedEx Ground CAN |
20202 | FedEx Intnl Economy CAN |
20203 | FedEx Priority Overnight CAN |
20204 | FedEx Intnl First CAN |
20205 | FedEx Int Priority Freight |
20401 | Purolator Express |
20402 | Purolator Ground 9AM |
20403 | Purolator Ground 10:30am |
20404 | Purolator Ground Evening |
20405 | Purolator Express 9am |
20406 | Purolator Express 10:30am |
20407 | Purolator Express Evening |
20408 | Purolator Ground |
20801 | Loomis Ground |
20802 | Loomis Saturday Delivery |
20803 | Loomis Residential Delivery |
20804 | Loomis Express Domestic 9:00 |
20805 | Loomis Express Domestic 12:00 |
20806 | Loomis Express Domestic 18:00 |
20206 | FedEx 2nd Day CAN |
FEDEX 2 DAY AM | FedEx 2nd Day AM |
20207 | FedEx 2nd Day AM CAN |
20208 | FedEx Express Saver CAN |
20209 | FedEx First Overnight CAN |
20210 | FedEx Home Delivery CAN |
FEDEX INT ECON | FedEx Intnl Economy |
FEDEX INT FIRST | FedEx Intnl First |
20211 | FedEx Intnl Priority CAN |
20212 | FedEx Standard Overnight CAN |
ONTRAC SUNRISE | Sunrise by 10:30 am |
ONTRAC GOLD | Sunrise Gold by 8am |
GET sales-orders/{salesOrderNumber}
Gets a sales order that has already been submitted.
Request:
https://api.premierwd.com/api/v5/sales-orders/0001234567
Response:
{
"salesOrderNumber": "0001234567",
"customerNumber": "01CUSTO21",
"customerPurchaseOrderNumber": "234235",
"shipToAddress": {
"name": "CUSTOMER 021",
"addressLine1": "9999 1st Ave",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"addressLine5": "2082222222",
"city": "Rexburg",
"regionCode": "ID",
"postalCode": "83440",
"countryCode": "US",
"phone": "2082222222"
},
"salesOrderLines": [
{
"itemNumber": "MBRGM8427",
"quantity": 1,
"shipMethod": "UPS Ground",
"isDropship": false,
"warehouseCode": "TX-1-US",
"unitPrice": 122.936,
"tradeDiscountAmount": 0,
"freightAmount": 2
}
],
"tradeDiscountAmount": 0,
"shippingAmount": 8,
"paymentTerms": 6
}
Invoice
The invoice API returns an authenticated customer's invoices filtered by invoice properties such as createdBeginDate, createdEndDate, invoiceNumber, salesOrderNumber, and/or itemNumber. Whole invoices, invoice headers, invoice lines, or invoice payments can be requested.
GET invoices?[createdBeginDate={createdBeginDate}]&[createdEndDate={createdEndDate}]&[invoiceNumber={invoiceNumber}]&[salesOrderNumber={salesOrderNumber}]&[itemNumber={itemNumber}]
Returns the invoices filtered by the specified parameters.
Request:
https://api.premierwd.com/api/v5/invoices?createdBeginDate=08/24/2015
Response:
[
{
"header": {
"customerNumber": "01CUSTO21",
"invoiceNumber": "0009999998",
"transactionDate": "2016-05-23T00:00:00",
"transactionType": "CreditMemo",
"paymentTerms": "Due in 30 Days",
"billToAddress": {
"name": "CUSTOMER 021",
"addressLine1": "9999 1st Ave",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"addressLine5": "",
"city": "Rexburg",
"regionCode": "ID",
"postalCode": "83440",
"countryCode": "US"
},
"shipToAddress": {
"name": "CUSTOMER 021",
"addressLine1": "9999 1st Ave",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"addressLine5": "",
"city": "Rexburg",
"regionCode": "ID",
"postalCode": "83440",
"countryCode": "US"
},
"balance": 0,
"salesAmount": -125.8,
"shipAmount": 0,
"transactionAmount": -125.8,
"discountAmount": 0,
"salesTaxAmount": 0
},
"lines": [
{
"item": {
"itemNumber": "HUS98211",
"descriptions": [
{
"longDescription": "2008-10 CHEVY/GMC & 2007 NEW BODY STYLE CHEVY/GMC SILVERADO/SIERRA (INCLUDING HD MODELS) EXTENDED CAB MODELS (EXCEPT CHASSIS CAB OR TRUCKS W/MANUAL TRANSFER CASE SHIFTER) FRONT & 2ND SEAT CUSTOM MOLDED HUSKY WEATHERBEATERS BLACK",
"shortDescription": "98211"
}
]
},
"shipMethod": "UPS Ground",
"quantityShipped": -1,
"unitPrice": 125.8,
"freightAmount": 0,
"total": -125.8,
"deliveryMethod": "Standard",
"salesOrderNumber": "000234234",
"customerPurchaseOrderNumber": "2534234",
"createdDate": "2016-05-13T11:21:59.047",
"createdUserId": "",
"tradeDiscountAmount": 0,
"creditTotal": -125.8,
"creditFreightAmount": 0,
"creditUnitPrice": 125.8,
"originalInvoiceNumber": "00042343234",
"originalSalesOrderNumber": "000324234",
"warehouseCode": "UT-1-US"
}
],
"payments": [
{
"paymentTransactionNumber": "00010",
"transactionDate": "2016-06-07T00:00:00",
"paymentTransactionType": "CreditCard",
"paymentAmount": -125.8
}
]
}
]
GET invoices/headers?[&createdBeginDate={createdBeginDate}],[&createdEndDate={createdEndDate}],[&invoiceNumber={invoiceNumber}],[&salesOrderNumber={salesOrderNumber}],[&itemNumber={itemNumber}]
Returns the invoice header(s) filtered by the specified parameters.
Request:
https://api.premierwd.com/api/v5/invoices/headers?createdBeginDate=08/24/2015
Response:
[
{
"customerNumber": "01CUSTO21",
"invoiceNumber": "0009999998",
"transactionDate": "2015-08-24T00:00:00",
"transactionType": "CreditMemo",
"paymentTerms": "Due in 30 Days",
"billToAddress": {
"name": "CUSTOMER 021",
"addressLine1": "9999 1st Ave",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"addressLine5": "",
"city": "Rexburg",
"regionCode": "ID",
"postalCode": "83440",
"countryCode": "US"
},
"shipToAddress": {
"name": "CUSTOMER 021",
"addressLine1": "9999 1st Ave",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"addressLine5": "",
"city": "Rexburg",
"regionCode": "ID",
"postalCode": "83440",
"countryCode": "US"
},
"balance": -11.85,
"salesAmount": 0,
"shipAmount": -11.85,
"transactionAmount": -11.85,
"discountAmount": 0,
"salesTaxAmount": 0
},
{
"customerNumber": "01CUSTO21",
"invoiceNumber": "0009999999",
"transactionDate": "2015-08-31T00:00:00",
"transactionType": "FinanceCharge",
"paymentTerms": "1% Disc 10 Days, Due in 30",
"billToAddress": {
"name": "CUSTOMER 021",
"addressLine1": "9999 1st Ave",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"addressLine5": "",
"city": "Rexburg",
"regionCode": "ID",
"postalCode": "83440",
"countryCode": "US"
},
"shipToAddress": {
"name": "CUSTOMER 021",
"addressLine1": "9999 1st Ave",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"addressLine5": "",
"city": "Rexburg",
"regionCode": "ID",
"postalCode": "83442",
"countryCode": "US"
}
}
]
GET invoices/{invoiceNumber}/lines
Returns the invoice line(s) filtered by the specified parameters.
Request:
https://api.premierwd.com/api/v5/invoices/9197990/lines
Response:
[
{
"item": {
"itemNumber": "LTFRMDL170HT",
"descriptions": [
{
"longDescription": "12v 100w Xenophot Halogen (Pair)",
"shortDescription": "RMDL170HT"
}
]
},
"shipMethod": "UPS Ground",
"quantityShipped": -1,
"unitPrice": 125.8,
"freightAmount": 0,
"total": -125.8,
"deliveryMethod": "Standard",
"salesOrderNumber": "0009999946",
"customerPurchaseOrderNumber": "999984",
"createdDate": "2016-05-13T11:21:59.047",
"createdUserId": "usere",
"tradeDiscountAmount": 0,
"creditTotal": -125.8,
"creditFreightAmount": 0,
"creditUnitPrice": 125.8,
"originalInvoiceNumber": "0009999916",
"originalSalesOrderNumber": "0009999946",
"warehouseCode": "UT-1-US"
}
]
GET invoices/{invoiceNumber}/payments
Returns the invoice payment(s) filtered by the specified parameters.
Request:
https://api.premierwd.com/api/v5/invoices/0009197990/payments
Response:
[
{
"paymentTransactionNumber": "app-CR",
"transactionDate": "2015-09-07T00:00:00",
"paymentTransactionType": "CreditCard",
"paymentAmount": 0
},
{
"paymentTransactionNumber": "0009999999",
"transactionDate": "2015-09-07T00:00:00",
"paymentTransactionType": "CreditCard",
"paymentAmount": 12.54
}
]