{"info":{"_postman_id":"3c529273-7b08-441e-b824-4c3123760995","name":"POS Partner Developer API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"37217774","collectionId":"3c529273-7b08-441e-b824-4c3123760995","publishedId":"2sA3rxpspb","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"7dab46"},"publishDate":"2024-08-20T18:35:30.000Z"},"item":[{"name":"Create Order","id":"e5a404fa-1c81-479e-9418-7d408629bc15","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true,"content-length":true},"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order\": {\r\n \"shipToName\": \"Acme Drug Emporium\",\r\n \"shipToContact\": \"David King\",\r\n \"shipToContactEmail\": \"davidking@drugemp.com\",\r\n \"customerNum\": \"9900\",\r\n \"salesDocId\": \"NEW CDE ORDER\",\r\n \"customerPo\": \"1234567\",\r\n \"shipAddressCode\": \"DE-9900\",\r\n \"shipToAdd1\": \"8200 Pharmacy Road\",\r\n \"shipToAdd2\": \"\",\r\n \"shipToAdd3\": \"\",\r\n \"shipToCity\": \"Atlanta\",\r\n \"shipToState\": \"GA\",\r\n \"shipToZip\": \"30350\",\r\n \"shipToCountryCode\": \"USA\",\r\n \"shipToPhone1\": \"555-555-1212\",\r\n \"shipToShippingMethod\": \"FEDEX GROUND\",\r\n \"notes\": \"\",\r\n \"orderLines\": {\r\n \"items\": [\r\n {\r\n \"item\": \"A920 & SIM DEVICE KIT\",\r\n \"quantity\": 1,\r\n \"lineItemId\": \"\"\r\n },\r\n {\r\n \"item\": \"WELCOME KIT\",\r\n \"quantity\": 1,\r\n \"lineItemId\": \"\"\r\n } \r\n ]\r\n },\r\n \"accountOption\": \"Third Party\",\r\n \"shippingAccount\": \"713037222\",\r\n \"partner\": \"BuyRite\",\r\n \"client\": \"Drug Store\",\r\n \"location\": \"SE\",\r\n \"salesRepEmail\": \"billsmith@drugemp.com\",\r\n \"serialNumber\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/order","description":"

POST Create Order

Create Order Request.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
partnerId	String	✅ Yes	Unique ID of the partner for whom order is being created.

JSON Request Field Descriptions

Order Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Data Type	Required	Description
shipToName	String	✅ Yes	Name of the shipping recipient.
shipToContact	String	✅ Yes	Contact person for shipping.
shipToContactEmail	String (Email)	✅ Yes	Email address of the shipping contact.
customerNum	String	✅ Yes	Unique customer number.
salesDocId	String	✅ Yes	Identifier for the sales document.
customerPo	String	✅ Yes	Customer purchase order number.
shipAddressCode	String	✅ Yes	Unique code for the shipping address.
shipToAdd1	String	✅ Yes	Primary shipping address line.
shipToAdd2	String	❌ No	Secondary shipping address line.
shipToAdd3	String	❌ No	Additional address line, if applicable.
shipToCity	String	✅ Yes	City for the shipping address.
shipToState	String	✅ Yes	State for the shipping address.
shipToZip	String	✅ Yes	Zip/postal code for the shipping address.
shipToCountryCode	String	✅ Yes	Country code for the shipping address (e.g., \"USA\").
shipToPhone1	String	✅ Yes	Primary phone number for shipping.
shipToShipMethod	String	✅ Yes	Shipping method (e.g., \"FEDEX GROUND\").
notes	String	❌ No	Notes related to the order.
accountOption	String	✅ Yes	Shipping account option (e.g., \"Third Party\").
shippingAccount	String	✅ Yes	Account number for shipping.
partner	String	❌ No	Partner Defined Field
client	String	❌ No	Partner Defined Field.
location	String	❌ No	Partner Defined Field
salesRepEmail	String (Email)	❌ No	Partner Defined Field
serialNumber	String (Comma-separated)	❌ No	List of serial numbers.

OrderLines (Nested Array)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Data Type	Required	Description
item	String	✅ Yes	Name of the ordered item.
quantity	Integer	✅ Yes	Quantity of the item ordered.
lineItemId	String	❌ No	Partner Specific Field

These tables summarizes the fields and their descriptions for the JSON payload.

Username, Password and parterId will be supplied by CDE Services, Inc.

\n","urlObject":{"protocol":"https","port":"9093","path":["ws","rest","CDEServices","order"],"host":["webservices","cdesolutions","com"],"query":[],"variable":[]}},"response":[{"id":"eba566a8-b541-47a3-aac4-606003b9fdfa","name":"200 - New Mode - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order\": {\r\n \"shipToName\": \"Acme Drug Emporium\",\r\n \"shipToContact\": \"David King\",\r\n \"shipToContactEmail\": \"davidking@drugemp.com\",\r\n \"customerNum\": \"9900\",\r\n \"salesDocId\": \"NEW CDE ORDER\",\r\n \"customerPo\": \"1234567\",\r\n \"shipAddressCode\": \"DE-9900\",\r\n \"shipToAdd1\": \"8200 Pharmacy Road\",\r\n \"shipToAdd2\": \"\",\r\n \"shipToAdd3\": \"\",\r\n \"shipToCity\": \"Atlanta\",\r\n \"shipToState\": \"GA\",\r\n \"shipToZip\": \"30350\",\r\n \"shipToCountryCode\": \"USA\",\r\n \"shipToPhone1\": \"678-517-7029\",\r\n \"shipToShippingMethod\": \"FEDEX GROUND\",\r\n \"notes\": \"\",\r\n \"orderLines\": {\r\n \"items\": [\r\n {\r\n \"item\": \"A920 & SIM DEVICE KIT\",\r\n \"quantity\": 1,\r\n \"lineItemId\": \"\"\r\n },\r\n {\r\n \"item\": \"WELCOME KIT\",\r\n \"quantity\": 1,\r\n \"lineItemId\": \"\"\r\n } \r\n ]\r\n },\r\n \"accountOption\": \"Third Party\",\r\n \"shippingAccount\": \"713037222\",\r\n \"partner\": \"BuyRite\",\r\n \"client\": \"Drug Store\",\r\n \"location\": \"SE\",\r\n \"salesRepEmail\": \"billsmith@drugemp.com\",\r\n \"serialNumber\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"151"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"hasError\": \"false\",\n \"messages\": {\n \"message\": \"New Order Created\",\n \"orderNbr\": \"CDE0000732\"\n }\n }\n}"},{"id":"8335c817-44f7-46ff-afa1-d4b67ffdf332","name":"400 - New Mode - Bad Request Validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"order\": {\r\n \"shipToName\": \"\",\r\n \"shipToContact\": \"David King\",\r\n \"shipToContactEmail\": \"davidking@drugemp.com\",\r\n \"customerNum\": \"\",\r\n \"salesDocId\": \"NEW CDE ORDER\",\r\n \"customerPo\": \"1234567\",\r\n \"shipAddressCode\": \"DE-9900\",\r\n \"shipToAdd1\": \"8200 Pharmacy Road\",\r\n \"shipToAdd2\": \"\",\r\n \"shipToAdd3\": \"\",\r\n \"shipToCity\": \"Atlanta\",\r\n \"shipToState\": \"GA\",\r\n \"shipToZip\": \"30350\",\r\n \"shipToCountryCode\": \"USA\",\r\n \"shipToPhone1\": \"678-517-7029\",\r\n \"shipToShippingMethod\": \"FEDEX GROUND\",\r\n \"notes\": \"\",\r\n \"orderLines\": {\r\n \"items\": [\r\n {\r\n \"item\": \"A920 & SIM DEVICE KIT\",\r\n \"quantity\": 1,\r\n \"lineItemId\": \"\"\r\n },\r\n {\r\n \"item\": \"WELCOME KIT\",\r\n \"quantity\": 1,\r\n \"lineItemId\": \"\"\r\n } \r\n ]\r\n },\r\n \"accountOption\": \"Third Party\",\r\n \"shippingAccount\": \"713037222\",\r\n \"partner\": \"BuyRite\",\r\n \"client\": \"Drug Store\",\r\n \"location\": \"SE\",\r\n \"salesRepEmail\": \"billsmith@drugemp.com\",\r\n \"serialNumber\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/order"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"303"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"hasError\": \"true\",\n \"validationErrors\": {\n \"error\": [\n {\n \"field\": \"shipToName\",\n \"message\": \"Field Required\"\n },\n {\n \"field\": \"customerNum\",\n \"message\": \"Field Required\"\n }\n ]\n }\n }\n}"}],"_postman_id":"e5a404fa-1c81-479e-9418-7d408629bc15"},{"name":"Shipment Details","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"e47a1764-7839-414d-85a1-714e071cb1e2"}}],"id":"be81e445-f3cc-49e4-95a3-32bc3a1ebfb4","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/shipmentDetails","description":"

Get Shipment Details

Retrieves shipment details based on the provided date, records per page, page number, and partner ID parameters.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
date	Date	Yes	Date for which shipment details are requested (YYYY-MM-DD)
recordsPerPage	Integer	No	Number of records to be displayed per page
page	Integer	No	Page number for pagination
partnerId	String	Yes	Unique ID of the partner for whom details are fetched

Response

The API returns a JSON object with the following structure:

{\n    \"data\": [\n        {\n            \"Sales Order Number\": \"\",\n            \"Customer Number\": 0,\n            \"Customer Name\": \"\",\n            \"Ship To Address Code\": \"\",\n            \"Ship To Name\": \"\",\n            \"Item Number\": \"\",\n            \"Item Base Term\": \"\",\n            \"Line Item ID\": \"\",\n            \"Serial Lot Number\": \"\",\n            \"Tracking Number\": \"\",\n            \"Ship Date\": \"\",\n            \"Tamper Bag Serial Number\": \"\",\n            \"Long Serial Number\": \"\",\n            \"KSN\": \"\",\n            \"Partner\": \"\",\n            \"Client\": \"\",\n            \"Location\": \"\",\n            \"Share With\": null,\n            \"LAN MAC\": null,\n            \"WIFI MAC\": null\n        }\n    ],\n    \"links\": {\n        \"first\": \"\",\n        \"last\": \"\",\n        \"prev\": null,\n        \"next\": \"\"\n    },\n    \"meta\": {\n        \"current_page\": 0,\n        \"last_page\": 0,\n        \"per_page\": 0,\n        \"total\": 0\n    }\n}\n\n

The data key contains an array of shipment details, with each object containing information such as Sales Order Number, Customer Number, Customer Name, Item Number, Tracking Number, Ship Date, and more.

The links key provides links to the first, last, previous, and next pages of the shipment details.

The meta key includes metadata about the current page, last page, records per page, and total number of records.

Required Username, Password and partnerId will be supplied by CDE Services, Inc.

Field Descriptions

Field (Key)	Type	Description
Sales Order Number	String	Unique value for each Order assigned by CDE
Customer Number	Integer	Customer Identification number
Customer Name	String	The name of the customer.
Ship To Address Code	String	The code for the shipping address.
Ship To Name	String	Company name of the recipient.
Item Number	String	CDE assigned value that identifies the item shipped
Item Base Term	String	The terminal model
Line Item ID	String	dentifier for the line item.
Serial Lot Number	String	Serial number of the Terminal assigned by the manufacturer
Tracking Number	String	Shipment tracking number assigned by the shipping carrier
Ship Date	String	The date the item was shipped.
Tamper Bag Serial Number	String	The serial number of the tamper bag. (for P2PE shipments)
Long Serial Number	String	Long Serial Number
KSN	String	KSN
*Partner	String	Partner / customer specific field
*Client	String	Partner / customer specific field
*Location	String	Partner / customer specific field
*Share With	String	Partner / customer specific field
LAN MAC	String	LAN MAC address of the terminal shipped if applicable.
WIFI MAC	String	The WiFi MAC address of the terminal shipped if applicable

*Indicates - Customer Specific Field (Key)

\n","urlObject":{"protocol":"https","port":"9093","path":["ws","rest","CDEServices","shipmentDetails"],"host":["webservices","cdesolutions","com"],"query":[{"disabled":true,"key":"date","value":"2019-07-26"},{"disabled":true,"key":"recordsPerPage","value":"3"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"partnerID","value":"EN4fePAZxFM26WvQTzRkCaShnyrjDBtcKuG58p9V3JUbmXws"}],"variable":[]}},"response":[{"id":"c41b08bb-4e4e-483e-a7dd-c996e9545273","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"url":{"raw":"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/shipmentDetails?date=2019-07-26&recordsPerPage=3&page=1&partnerId=EN4fePAZxFM26WvQTzRkCaShnyrjDBtcKuG58p9V3JUbmXws","protocol":"https","host":["webservices","cdesolutions","com"],"port":"9093","path":["ws","rest","CDEServices","shipmentDetails"],"query":[{"key":"date","value":"2019-07-26"},{"key":"recordsPerPage","value":"3"},{"key":"page","value":"1"},{"key":"partnerId","value":"EN4fePAZxFM26WvQTzRkCaShnyrjDBtcKuG58p9V3JUbmXws"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3181"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"Sales Order Number\": \"ZZ0000008\",\n \"Customer Number\": 5151,\n \"Customer Name\": \"Test Company\",\n \"Ship To Address Code\": \"FO-63337\",\n \"Ship To Name\": \"Test University\",\n \"Item Number\": \"MOVE5000-012090516900452453000\",\n \"Item Base Term\": \"MOVE5000\",\n \"Line Item ID\": \"FLI-11757A\",\n \"Serial Lot Number\": \"320118172620627\",\n \"Tracking Number\": \"1Z30161E03903408\",\n \"Ship Date\": \"2019-07-26 14:59:33.0\",\n \"Tamper Bag Serial Number\": \"BF26440\",\n \"Long Serial Number\": null,\n \"KSN\": null,\n \"Partner\": \"Test Information Systems\",\n \"Client\": \"Test University\",\n \"Location\": \"Main Campus\",\n \"Share With\": null,\n \"LAN MAC\": null,\n \"WIFI MAC\": null\n },\n {\n \"Sales Order Number\": \"ZZ10010562\",\n \"Customer Number\": 5159,\n \"Customer Name\": \"TEST PAYMENT SYSTEMS\",\n \"Ship To Address Code\": \"FO-63624\",\n \"Ship To Name\": \"Test SF\",\n \"Item Number\": \"A80-011670200000154000000\",\n \"Item Base Term\": \"A80\",\n \"Line Item ID\": \"FLI-11868Z\",\n \"Serial Lot Number\": \"124045337\",\n \"Tracking Number\": \"2775632532\",\n \"Ship Date\": \"2019-07-26 17:37:23.0\",\n \"Tamper Bag Serial Number\": \"BF26441\",\n \"Long Serial Number\": null,\n \"KSN\": null,\n \"Partner\": \"TEST SF\",\n \"Client\": \"TEST BAY\",\n \"Location\": \"TEST BAY\",\n \"Share With\": null,\n \"LAN MAC\": \"C8:40:52:2A:F5:AA\",\n \"WIFI MAC\": \"70:3E:97:D2:15:BB\"\n },\n {\n \"Sales Order Number\": \"ZZ10010562\",\n \"Customer Number\": 5159,\n \"Customer Name\": \"TEST PAYMENT SYSTEMS\",\n \"Ship To Address Code\": \"FO-63624\",\n \"Ship To Name\": \"Test SF\",\n \"Item Number\": \"SREDKEY2-010620100000000000000\",\n \"Item Base Term\": \"SREDKEY-2\",\n \"Line Item ID\": \"FLI-11869W\",\n \"Serial Lot Number\": \"419R20870\",\n \"Tracking Number\": \"2775632532\",\n \"Ship Date\": \"2019-07-26 17:37:23.0\",\n \"Tamper Bag Serial Number\": \"BF26506\",\n \"Long Serial Number\": null,\n \"KSN\": null,\n \"Partner\": \"Test SF\",\n \"Client\": \"TEST BAY\",\n \"Location\": \"TEST BAY\",\n \"Share With\": null,\n \"LAN MAC\": null,\n \"WIFI MAC\": null\n }\n ],\n \"links\": {\n \"first\": \"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/shipmentDetails?date=2019-07-26&partnerId=EN4fePAZxFM26WvQTzRkCaShnyrjDBtcKuG58p9V3JUbmXws&recordsPerPage=3&page=1\",\n \"last\": \"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/shipmentDetails?date=2019-07-26&partnerId=EN4fePAZxFM26WvQTzRkCaShnyrjDBtcKuG58p9V3JUbmXws&recordsPerPage=3&page=5\",\n \"prev\": null,\n \"next\": \"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/shipmentDetails?date=2019-07-26&partnerId=EN4fePAZxFM26WvQTzRkCaShnyrjDBtcKuG58p9V3JUbmXws&recordsPerPage=3&page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 5,\n \"per_page\": 3,\n \"total\": 14\n }\n}"},{"id":"326dbf8c-48fd-4eba-9dad-898ac2b0f584","name":"400 - Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"url":{"raw":"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/shipmentDetails?recordsPerPage=10&page=1","protocol":"https","host":["webservices","cdesolutions","com"],"port":"9093","path":["ws","rest","CDEServices","shipmentDetails"],"query":[{"key":"date","value":"2024-07-26","disabled":true},{"key":"recordsPerPage","value":"10"},{"key":"page","value":"1"},{"key":"partnerId","value":"EN4fePAZxFM26WvQTzRkCaShnyrjDBtcKuG58p9V3JUbmXws","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"384"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"hasError\": \"true\",\n \"validationErrors\": {\n \"error\": [\n {\n \"partnerId\": \"\",\n \"message\": \"Partner ID is invalid.\",\n \"required\": \"yes\"\n },\n {\n \"date\": \"\",\n \"message\": \"Date is invalid or has incorrect format, parameter should be in YYYY-MM-DD format.\",\n \"required\": \"yes\"\n }\n ]\n }\n }\n}"}],"_postman_id":"be81e445-f3cc-49e4-95a3-32bc3a1ebfb4"},{"name":"Open Orders","id":"1326976b-a5e6-44ca-bb07-b718db6bd436","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/openOrders","description":"

Get Open Orders

Retrieves open orders based on the records per page, page number, and partner ID parameters.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
recordsPerPage	Integer	No	Number of records to be displayed per page
page	Integer	No	Page number for pagination
partnerId	String	Yes	Unique ID of the partner for whom details are fetched

Response

The API returns a JSON object with the following structure:

{\n    \"data\": [\n        {\n            \"Customer Number\": \"\",\n            \"Sales Document Number\": \"\",\n            \"Sales Batch\": \"\",\n            \"Ship To Name\": \"\",\n            \"Ship To Address Code\": \"\",\n            \"Document Date\": \"\",\n            \"Payment Date\": \"\", \n            \"Contact Name\": \"\", \n            \"Contact Person\": \"\", \n            \"Total\": \"\",\n            \"Pay Link URL\": \"\"\n        }\n    ],\n    \"links\": {\n        \"first\": \"\",\n        \"last\": \"\",\n        \"prev\": null,\n        \"next\": \"\"\n    },\n    \"meta\": {\n        \"current_page\": 0,\n        \"last_page\": 0,\n        \"per_page\": 0,\n        \"total\": 0\n    }\n}\n\n

The data key contains an array of open orders, with each object containing information such as Customer Number, Sales Document Number, Sales Batch, Ship To Name, Ship To Address Code, and Document Date. Paylink records will also contain Payment Date, Contact Name, Contact Person, Total and Pay Link URL.

The links key provides links to the first, last, previous, and next pages of the shipment details.

The meta key includes metadata about the current page, last page, records per page, and total number of records.

Username, Password and partnerId will be supplied by CDE Services, Inc.

Field Descriptions

Field (Key)	Type	Description
Customer Number	String	The unique identifier for the customer.
Sales Document Number	String	The unique identifier for the sales document.
Sales Batch	String	The sales batch associated with the document.
Ship To Name	String	The name of the entity to which the shipment is sent.
Ship To Address Code	String	The code representing the shipping address.
Document Date	String	The date when the document was created.
Payment Date	String	The date of payment
Contact Name	String	Contact Name for the order
Contact Person	String	Contact Person for the order
Total	String	The Total Amount of order
Pay Link URL	String	Pay Link URL
first (links)	String	URL for the first page of data.
last (links)	String	URL for the last page of data.
prev (links)	String	URL for the previous page of data, if any.
next (links)	String	URL for the next page of data.
current_page (meta)	Integer	The current page number.
last_page (meta)	Integer	The number of the last page available.
per_page (meta)	Integer	The number of records per page.
total (meta)	Integer	The total number of records available.

","urlObject":{"protocol":"https","port":"9093","path":["ws","rest","CDEServices","openOrders"],"host":["webservices","cdesolutions","com"],"query":[{"disabled":true,"key":"recordsPerPage","value":"4"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"partnerId","value":"EN4fePAZxFM26WvQTzRkCaShnyrjDBtcKuG58p9V3JUbmXws"}],"variable":[]}},"response":[{"id":"fc4e9106-cca2-46f7-9ee5-c3e2d6e706cc","name":"200 - Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"url":{"raw":"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/openOrders?recordsPerPage=4&page=1&partnerId=EN4fePAZxFM26WvQTzRkCaShnyrjDBtcKuG58p9V3JUbmXws","protocol":"https","host":["webservices","cdesolutions","com"],"port":"9093","path":["ws","rest","CDEServices","openOrders"],"query":[{"key":"recordsPerPage","value":"4"},{"key":"page","value":"1"},{"key":"partnerId","value":"EN4fePAZxFM26WvQTzRkCaShnyrjDBtcKuG58p9V3JUbmXws"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1824"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"Customer Number\": \"5151\",\n \"Sales Document Number\": \"CLOPE0000009\",\n \"Sales Batch\": \"RDY TO INV\",\n \"Ship To Name\": \"Test University One\",\n \"Ship To Address Code\": \"FO-63348\",\n \"Document Date\": \"2024-06-20 00:00:00.0\"\n },\n {\n \"Customer Number\": \"5151\",\n \"Sales Document Number\": \"CLOPE0000023\",\n \"Sales Batch\": \"PICK MO\",\n \"Ship To Name\": \"Test University Two\",\n \"Ship To Address Code\": \"FO-63614\",\n \"Document Date\": \"2024-07-24 00:00:00.0\"\n },\n {\n \"Customer Number\": \"5151\",\n \"Sales Document Number\": \"CLOPE0000027\",\n \"Sales Batch\": \"ON HOLD\",\n \"Ship To Name\": \"Test University Three\",\n \"Ship To Address Code\": \"FO-63789\",\n \"Document Date\": \"2024-08-07 00:00:00.0\"\n },\n {\n \"Customer Number\": \"5151\",\n \"Sales Document Number\": \"CLOPE0000028\",\n \"Sales Batch\": \"WAIT FOR EQPT\",\n \"Ship To Name\": \"Test University Four\",\n \"Ship To Address Code\": \"FO-63791\",\n \"Document Date\": \"2024-08-07 00:00:00.0\"\n },\n {\n \"Customer Number\" : \"5151\",\n \"Sales Document Number\" : \"PEPL99999999\",\n \"Sales Batch\" : \"PENDING PYMT\",\n \"Ship To Name\" : \"Test University Five\",\n \"Ship To Address Code\" : \"FO-12345\",\n \"Document Date\" : \"2024-08-07 00:00:00.0\",\n \"Payment Date\" : \"2024-10-10 10:00:00.000\",\n \"Contact Name\" : \"Contact Name\",\n \"Contact Person\" : \"Contact Person Name\",\n \"Total\" : \"70.00000\",\n \"Pay Link URL\" : \"https://www.payfabric.com/PayLink/Web/ZZZ-YYYY_MMM-ABCDEFGHIJ\"\n }\n ],\n \"links\": {\n \"first\": \"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/openOrders?partnerId=EN4fePAZxFM26WvQTzRkCaShnyrjDBtcKuG58p9V3JUbmXws&recordsPerPage=4&page=1\",\n \"last\": \"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/openOrders?partnerId=EN4fePAZxFM26WvQTzRkCaShnyrjDBtcKuG58p9V3JUbmXws&recordsPerPage=4&page=24\",\n \"prev\": null,\n \"next\": \"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/openOrders?partnerId=EN4fePAZxFM26WvQTzRkCaShnyrjDBtcKuG58p9V3JUbmXws&recordsPerPage=4&page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"last_page\": 24,\n \"per_page\": 4,\n \"total\": 96\n }\n}"},{"id":"85df87a1-c9ea-456e-82c3-64695c718eec","name":"400 - Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text","disabled":true},{"key":"Content-Type","value":"application/json","type":"text","disabled":true}],"url":{"raw":"https://webservices.cdesolutions.com:9093/ws/rest/CDEServices/openOrders?recordsPerPage=4&page=1&partnerId=","protocol":"https","host":["webservices","cdesolutions","com"],"port":"9093","path":["ws","rest","CDEServices","openOrders"],"query":[{"key":"recordsPerPage","value":"4"},{"key":"page","value":"1"},{"key":"partnerId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"238"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"hasError\": \"true\",\n \"validationErrors\": {\n \"error\": [\n {\n \"partnerId\": \"\",\n \"message\": \"Partner ID is invalid.\",\n \"required\": \"yes\"\n }\n ]\n }\n }\n}"}],"_postman_id":"1326976b-a5e6-44ca-bb07-b718db6bd436"}]}