nexus-api

name	Nexus API
description	Use when working with bin transfer hdr, bin transfer line, health check, purchase order receipt, receiving, seed, transfer, transfer receipt, transfer shipping, users, or making API calls to https://nexus.augur-api.com.
version	1.0.5

Nexus

Service-specific knowledge for nexus microservice.

API Documentation

• OpenAPI Specification
• Postman Collection

Authentication

All endpoints except /health-check and /ping require bearer token authentication. See authentication.md for details.

API Endpoints

bin_transfer_hdr

Method	Endpoint	Description	Details
GET	/bin-transfer/{binTransferHdrUid}	Get Bin Transfer Details	bin_transfer_hdr.md
PUT	/bin-transfer/{binTransferHdrUid}	Update Bin Transfer	bin_transfer_hdr.md
DELETE	/bin-transfer/{binTransferHdrUid}	DELETE Bin Transfer	bin_transfer_hdr.md
GET	/bin-transfer	List Bin Transfers	bin_transfer_hdr.md
POST	/bin-transfer	Create Bin Transfer	bin_transfer_hdr.md
GET	/bin-transfer/{binTransferHdrUid}/status	Get Bin Transfer Status with Lines	bin_transfer_hdr.md

health_check

Method	Endpoint	Description	Details
GET	/health-check	Health Check	health_check.md
GET	/ping	Ping to get Pong	health_check.md

purchase_order_receipt

Method	Endpoint	Description	Details
GET	/purchase-order-receipt/{purchaseOrderReceiptUid}	Get Purchase Order Receipt Details	purchase_order_receipt.md
PUT	/purchase-order-receipt/{purchaseOrderReceiptUid}	Update Purchase Order Receipt	purchase_order_receipt.md
DELETE	/purchase-order-receipt/{purchaseOrderReceiptUid}	DELETE Purchase Order Receipt	purchase_order_receipt.md
GET	/purchase-order-receipt	List Purchase Order Receipts	purchase_order_receipt.md
POST	/purchase-order-receipt	Create Purchase Order Receipt	purchase_order_receipt.md

receiving

Method	Endpoint	Description	Details
GET	/receiving/{receivingUid}	Get Receiving Details	receiving.md
PUT	/receiving/{receivingUid}	Update Receiving	receiving.md
DELETE	/receiving/{receivingUid}	DELETE Receiving	receiving.md
GET	/receiving	List Receiving Records	receiving.md
POST	/receiving	Create Receiving	receiving.md

transfer

Method	Endpoint	Description	Details
GET	/transfer/{transferUid}	Get Transfer Details	transfer.md
PUT	/transfer/{transferUid}	Update Transfer	transfer.md
DELETE	/transfer/{transferUid}	DELETE Transfer	transfer.md
GET	/transfer	List Transfers	transfer.md
POST	/transfer	Create Transfer	transfer.md

transfer_receipt

Method	Endpoint	Description	Details
GET	/transfer-receipt/{transferReceiptUid}	Get Transfer Receipt Details	transfer_receipt.md
PUT	/transfer-receipt/{transferReceiptUid}	Update Transfer Receipt	transfer_receipt.md
DELETE	/transfer-receipt/{transferReceiptUid}	DELETE Transfer Receipt	transfer_receipt.md
GET	/transfer-receipt	List Transfer Receipts	transfer_receipt.md
POST	/transfer-receipt	Create Transfer Receipt	transfer_receipt.md

transfer_shipping

Method	Endpoint	Description	Details
GET	/transfer-shipping/{transferReceiptUid}	Get Transfer Shipping Details	transfer_shipping.md
PUT	/transfer-shipping/{transferReceiptUid}	Update Transfer Shipping	transfer_shipping.md
DELETE	/transfer-shipping/{transferReceiptUid}	DELETE Transfer Shipping	transfer_shipping.md
GET	/transfer-shipping	List Transfer Shippings	transfer_shipping.md
POST	/transfer-shipping	Create Transfer Shipping	transfer_shipping.md