The Ship Connect OData API provides the ability to create and view Shipments and related Packages and Items .
\nTo start using the OData API, you need to -
\nYou must use a valid Basic Auth to send requests to the API endpoints. You can get your credentials from NRG Support.
\nThe API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
\nThe API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.
\nThe OData API uses Basic Auth for authentication.
\nYou must include credentials in each request to the OData API with the Basic Auth request header.
\nAlternatively, NRG Software can provide an API key which can be sent using an Authorization header.
\nAuthorization: Bearer **
or by adding the query parameter to your URL
\n?apiKey=**
If authentication is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.
\nIn case you have questions, please contact NRG Support for assistance.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1108389","collectionId":"7d9144ec-1498-4768-bd39-bae6fa3581af","publishedId":"2s9Y5WwiNt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-08-24T14:16:21.000Z"},"item":[{"name":"Shipments","item":[{"name":"Get All Shipments","id":"0ff891bd-0b71-449b-b892-4068e8219a04","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/Shipment","urlObject":{"path":["fmi","odata","v4","ShipManager_Data","Shipment"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0ff891bd-0b71-449b-b892-4068e8219a04"},{"name":"Get Single Shipment","id":"4107dbd1-f540-4b36-8637-7846a463b4d6","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/Shipment({{id}})","urlObject":{"path":["fmi","odata","v4","ShipManager_Data","Shipment({{id}})"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4107dbd1-f540-4b36-8637-7846a463b4d6"},{"name":"Get Single Shipment Packages","id":"8028fa06-1700-47ba-b420-2d30b9bbea58","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/Shipment({{id}})/Packages","urlObject":{"path":["fmi","odata","v4","ShipManager_Data","Shipment({{id}})","Packages"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8028fa06-1700-47ba-b420-2d30b9bbea58"},{"name":"Get Single Shipment Items","id":"29bf72a9-5631-4b24-9c5b-35613fe3fcfd","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/Shipment({{id}})/Items","urlObject":{"path":["fmi","odata","v4","ShipManager_Data","Shipment({{id}})","Items"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"29bf72a9-5631-4b24-9c5b-35613fe3fcfd"},{"name":"Get Single Shipment Rates","id":"fb21439d-2c7a-4873-bf03-78c965d9fb01","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/Shipment({{id}})/Rates","urlObject":{"path":["fmi","odata","v4","ShipManager_Data","Shipment({{id}})","Rates"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb21439d-2c7a-4873-bf03-78c965d9fb01"},{"name":"Create Shipment","id":"4a80244d-0aab-4220-a86c-4c04acf7b6c0","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/Shipment","urlObject":{"path":["fmi","odata","v4","ShipManager_Data","Shipment"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e3a2e769-ecd0-421e-aec2-34fba4c45cd0","name":"Create Shipment","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"_fk_LocationID.n\": 1,\n \"Carrier\": \"UPS\",\n \"Service\": \"UPS Ground\",\n \"Ref_InvoiceNumber\": \"InvNum\",\n \"Ref_CustomerReference\": \"CustRef\",\n \"Ref_PONumber\": \"PONum\",\n \"UserField_OrderDate\": \"2023-12-01\",\n \"UserField_Source\": \"OData\",\n \"UserField_ID\": \"12345\",\n \"Order_Notes.t\": \"Some Note\",\n \"Order_Method.t\": \"Free Shipping\",\n \"Special_DeliveryConfirmation\": \"\",\n \"ShipTo_Name\": \"NRG Software\",\n \"ShipTo_AttentionName\": \"Tech Support\",\n \"ShipTo_AddressLine1\": \"179 N Broadway\",\n \"ShipTo_AddressLine2\": \"\",\n \"ShipTo_City\": \"Milwaukee\",\n \"ShipTo_StateProvinceCode\": \"WI\",\n \"ShipTo_PostalCode\": \"53202\",\n \"ShipTo_Country\": \"United States\",\n \"ShipTo_PhoneNumber\": \"414-555-1212\",\n \"ShipTo_EmailAddress\": \"user@domain.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/Shipment"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"7d5c85eb-d7d3-4efd-9dcc-ec2310f1c7fa","name":"Create Shipment Advanced","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"_fk_LocationID.n\": 1,\n \"Carrier\": \"UPS\",\n \"Service\": \"UPS Ground\",\n \"Ref_InvoiceNumber\": \"InvNum\",\n \"Ref_CustomerReference\": \"CustRef\",\n \"Ref_PONumber\": \"PONum\",\n \"UserField_OrderDate\": \"2023-12-01\",\n \"UserField_Source\": \"OData\",\n \"UserField_ID\": \"12345\",\n \"Order_Notes.t\": \"Some Note\",\n \"Order_Method.t\": \"Free Shipping\",\n \"Special_DeliveryConfirmation\": \"\",\n \"ShipTo_Name\": \"NRG Software\",\n \"ShipTo_AttentionName\": \"Tech Support\",\n \"ShipTo_AddressLine1\": \"179 N Broadway\",\n \"ShipTo_AddressLine2\": \"\",\n \"ShipTo_City\": \"Milwaukee\",\n \"ShipTo_StateProvinceCode\": \"WI\",\n \"ShipTo_PostalCode\": \"53202\",\n \"ShipTo_Country\": \"United States\",\n \"ShipTo_PhoneNumber\": \"414-555-1212\",\n \"ShipTo_EmailAddress\": \"user@domain.com\",\n \"Shipper_Name\": \"XYZ Co\",\n \"ShipFrom_Name\" : \"Label Printed Company\",\n \"ShipFrom_AttentionName\": \"Tech Support\",\n \"ShipFrom_AddressLine1\": \"1234 Elm St\",\n \"ShipFrom_City\": \"springfield\",\n \"ShipFrom_StateProvinceCode\" : \"IL\",\n \"ShipFrom_PostalCode\": \"62704\",\n \"ReturnLabel_Service\": \"UPS Ground\",\n \"ReturnLabel_Name\": \"Processing Center\",\n \"ReturnLabel_AttentionName\": \"Tech Support\",\n \"ReturnLabel_AddressLine1\": \"1234 Elm St\",\n \"ReturnLabel_City\": \"springfield\",\n \"ReturnLabel_StateProvinceCode\" : \"IL\",\n \"ReturnLabel_PostalCode\": \"62704\"\n\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/Shipment"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4a80244d-0aab-4220-a86c-4c04acf7b6c0"},{"name":"Create Shipment Packages","id":"7f15fd00-5c0a-4eb8-a487-9a645cca145b","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/Packages","urlObject":{"path":["fmi","odata","v4","ShipManager_Data","Packages"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ec2fb3a5-f001-4e38-9bac-17f7839a7b95","name":"Create Shipment Packages","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"_fk_ShipManagerID.n\": 1234,\n \"Packaging.t\": \"Package\",\n \"Weight.n\": 1.5,\n \"Length.n\": 12,\n \"Width.n\": 12,\n \"Height.n\": 12,\n \"WeightUnits.t\": \"Pounds\",\n \"Value.n\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/Packages"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"0d7e40de-6e7c-47da-932a-f16542846b9b","name":"Create Shipment Packages Advanced","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"_fk_ShipManagerID.n\": 1234,\n \"Packaging.t\": \"Package\",\n \"Weight.n\": 1.5,\n \"Length.n\": 12,\n \"Width.n\": 12,\n \"Height.n\": 12,\n \"WeightUnits.t\": \"Pounds\",\n \"BoxSize.t\": \"Big box\",\n \"Value.n\": 0\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/Packages"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7f15fd00-5c0a-4eb8-a487-9a645cca145b"},{"name":"Create Shipment Items","id":"5a35417d-8f50-46c9-8ba2-c14e322c129b","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/Items","urlObject":{"path":["fmi","odata","v4","ShipManager_Data","Items"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"87dc4824-9e8a-489b-a4ce-84ac2eb613ac","name":"Create Shipment Items","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"_fk_ShipManagerID.n\": 1234,\n \"Description\": \"Widgets\",\n \"PartNumber\": \"Part1234\",\n \"SKU\": \"SKU123\",\n \"Quantity\": 1,\n \"Weight\": 1.5,\n \"UnitPrice\": 12.50\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/Items"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5a35417d-8f50-46c9-8ba2-c14e322c129b"}],"id":"267d52d8-b884-4036-bb2b-9540cdcffeb0","_postman_id":"267d52d8-b884-4036-bb2b-9540cdcffeb0","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":true,"source":{"_postman_id":"7d9144ec-1498-4768-bd39-bae6fa3581af","id":"7d9144ec-1498-4768-bd39-bae6fa3581af","name":"OData API Documentation","type":"collection"}}},{"name":"Admin","item":[{"name":"Auth Test","id":"9f37d00e-93d7-4d79-8479-ec64dc8d5acb","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Data/$metadata","urlObject":{"path":["fmi","odata","v4","ShipManager_Data","$metadata"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9f37d00e-93d7-4d79-8479-ec64dc8d5acb"},{"name":"Get All Locations","id":"e97ef615-1285-4558-a3c6-4e8787281f41","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Prefs/Locations","urlObject":{"path":["fmi","odata","v4","ShipManager_Prefs","Locations"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e97ef615-1285-4558-a3c6-4e8787281f41"},{"name":"Get All Users","id":"61cd8598-09ed-4706-b434-27684de30f0b","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{base_url}}/fmi/odata/v4/ShipManager_Prefs/Locations","urlObject":{"path":["fmi","odata","v4","ShipManager_Prefs","Locations"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"61cd8598-09ed-4706-b434-27684de30f0b"}],"id":"8fe85b66-c885-47c2-a1f1-d34c969191f7","_postman_id":"8fe85b66-c885-47c2-a1f1-d34c969191f7","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":true,"source":{"_postman_id":"7d9144ec-1498-4768-bd39-bae6fa3581af","id":"7d9144ec-1498-4768-bd39-bae6fa3581af","name":"OData API Documentation","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]}},"event":[{"listen":"prerequest","script":{"id":"5d4d58cc-989b-439e-b68b-c31ac7e19e20","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ec5ae281-9c22-4e01-a054-1c3e16c3db03","type":"text/javascript","exec":[""]}}],"variable":[{"id":"8dfabaa2-f012-4b0a-b64e-73bdd8ae1708","key":"base_url","value":"{{base_url}}"},{"id":"d51ab295-1e86-477e-993b-61769743f8cb","key":"username","value":"{{username}}","type":"string"},{"id":"f5d0a1c4-9797-4988-8341-f12ac1f9653a","key":"password","value":"{{password}}","type":"string"},{"id":"251ec897-91b1-4d79-beba-4e859c8d0cef","key":"id","value":"{{id}}","type":"string"}]}