This collection contains our publicly accessible REST API's.
\nBy default test orders are not included in responses. To include test orders add the following:
\nGET - Include withTestOrders=1 in query paramater.
\nPOST - Include withTestOrders=1 in body.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4293453","collectionId":"55048ce0-54f6-4d96-8deb-04c8a444dfb4","publishedId":"UVR7LUM6","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"333745","highlight":"0850C7"},"publishDate":"2025-11-07T20:36:59.000Z"},"item":[{"name":"Orders","item":[{"name":"Get Order","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"order_id\", jsonData._id); "],"type":"text/javascript","packages":{}}}],"id":"1d2bac9f-9fd3-4a9a-9d91-0c2bf715cc7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/orders/{{orderId}}/full?withTestOrders=false","description":"Method: GET
URL: https://api.mpowerpromo.com/orders/{{orderId}}/full
Authentication: Required (JWT Bearer token)
Note: This endpoint uses the numeric orderId, not the MongoDB _id.
While this endpoint doesn't have explicit query parameters in the URL, you can pass these internally through the request:
\nNote: Test orders are automatically excluded unless this flag is set or you're accessing from admin portal.
\nReturns a comprehensive order object with all nested data fully populated.
\nEach item in the PurchaseOrders array contains:
Each item in PurchaseOrders[].LineItemArray contains:
{\n \"_id\": \"507f1f77bcf86cd799439050\",\n \"orderId\": 12345,\n \"orderStatus\": \"Processing\",\n \"orderType\": \"Decorated\",\n \"initialType\": \"New Quote Request\",\n \"orderEmail\": \"customer@example.com\",\n \"dueDate\": \"12/31/2025\",\n \"orderDate\": null,\n \"createdDate\": \"2025-11-07T10:30:00.000Z\",\n \"productTotal\": 1250.00,\n \"productTotalCost\": 812.50,\n \"chargeTotal\": 125.00,\n \"chargeTotalCost\": 75.00,\n \"taxTotal\": 0,\n \"shippingTotal\": 50.00,\n \"discountTotal\": 0,\n \"orderDiscount\": 0,\n \"productMargin\": 35,\n \"paymentsTotal\": 500.00,\n \"balance\": 925.00,\n \"rushOrder\": true,\n \"isFlagged\": false,\n \"firmDueDate\": true,\n \"currency\": \"USD\",\n \"currencyRate\": 1,\n \"allowCreditCardPayments\": true,\n \"allowECheckPayments\": true,\n \"storeId\": {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"storeName\": \"Acme Promo Store\",\n \"storeUrl\": \"acmepromo.com\",\n \"StoreEmails\": [{\n \"emailType\": \"Order Confirmation\",\n \"email\": \"orders@acmepromo.com\"\n }],\n \"distributorId\": {\n \"_id\": \"507f1f77bcf86cd799439010\",\n \"logo\": \"https://example.com/logo.png\"\n },\n \"StoreFulfillment\": []\n },\n \"customerId\": {\n \"_id\": \"507f1f77bcf86cd799439012\",\n \"userId\": {\n \"_id\": \"507f1f77bcf86cd799439013\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john@example.com\",\n \"photo\": \"https://example.com/photo.jpg\"\n },\n \"companyId\": {\n \"_id\": \"507f1f77bcf86cd799439015\",\n \"companyName\": \"Acme Corporation\",\n \"CompanyAddresses\": [],\n \"CompanyBillingAddresses\": []\n },\n \"CustomerAddresses\": [],\n \"CustomerPhoneNumbers\": [],\n \"Documents\": []\n },\n \"distributorId\": {\n \"_id\": \"507f1f77bcf86cd799439010\",\n \"paymentProviders\": [],\n \"allowECheckPayments\": true,\n \"logo\": \"https://example.com/logo.png\",\n \"shippingCredentials\": {}\n },\n \"salesUserId\": {\n \"_id\": \"507f1f77bcf86cd799439013\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Sales\",\n \"email\": \"jane@company.com\",\n \"photo\": \"https://example.com/jane.jpg\"\n },\n \"adminUserId\": {\n \"_id\": \"507f1f77bcf86cd799439014\",\n \"firstName\": \"Admin\",\n \"lastName\": \"User\",\n \"email\": \"admin@company.com\"\n },\n \"createdByUserId\": {\n \"_id\": \"507f1f77bcf86cd799439013\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Sales\"\n },\n \"PurchaseOrders\": [\n {\n \"friendlyPurchaseOrderDetailId\": 1,\n \"status\": \"Sent to Supplier\",\n \"type\": \"Standard\",\n \"productId\": \"PROD-001\",\n \"SO\": \"SO-2025-001\",\n \"supplierCode\": \"ABC-12345\",\n \"productTotal\": 625.00,\n \"productTotalCost\": 406.25,\n \"chargeTotal\": 62.50,\n \"chargeTotalCost\": 37.50,\n \"total\": 712.50,\n \"margin\": 218.75,\n \"dueDate\": \"12/25/2025\",\n \"estimatedDeliveryDate\": \"12/25/2025\",\n \"supplier\": {\n \"_id\": \"507f1f77bcf86cd799439020\",\n \"name\": \"Supplier ABC\",\n \"website\": \"https://supplierabc.com\",\n \"phone\": \"555-1234\",\n \"isDecorator\": false,\n \"distSupplier\": {\n \"_id\": \"507f1f77bcf86cd799439021\",\n \"Integrations\": []\n }\n },\n \"LineItemArray\": [\n {\n \"productId\": \"PROD-001\",\n \"quantity\": 100,\n \"unitPrice\": 6.25,\n \"unitCost\": 4.06,\n \"total\": 625.00,\n \"totalCost\": 406.25,\n \"description\": \"Custom T-Shirt\",\n \"localProduct\": {\n \"_id\": \"507f1f77bcf86cd799439030\",\n \"productName\": \"T-Shirt - Cotton\",\n \"slug\": \"t-shirt-cotton\",\n \"productId\": \"PROD-001\",\n \"supplierCode\": \"ABC-12345\",\n \"supplierId\": {\n \"_id\": \"507f1f77bcf86cd799439020\",\n \"name\": \"Supplier ABC\"\n },\n \"restrictions\": []\n },\n \"PartArray\": [\n {\n \"partId\": \"PART-001\",\n \"description\": \"Size Large - Navy\",\n \"quantity\": 50,\n \"unitPrice\": 6.25,\n \"unitCost\": 4.06,\n \"ShipmentArray\": []\n },\n {\n \"partId\": \"PART-002\",\n \"description\": \"Size XL - Navy\",\n \"quantity\": 50,\n \"unitPrice\": 6.25,\n \"unitCost\": 4.06,\n \"ShipmentArray\": []\n }\n ],\n \"DecorationArray\": [\n {\n \"decorationId\": \"DECO-001\",\n \"decorationType\": \"Screen Print\",\n \"location\": \"Front Center\",\n \"colors\": 2\n }\n ],\n \"ShipmentArray\": []\n }\n ],\n \"ChargeArray\": [\n {\n \"chargeName\": \"Setup Fee\",\n \"chargeType\": \"Setup\",\n \"price\": 50.00,\n \"cost\": 30.00,\n \"quantity\": 1,\n \"total\": 50.00,\n \"totalCost\": 30.00\n }\n ],\n \"ShipmentArray\": [\n {\n \"shipmentId\": 1,\n \"companyName\": \"Acme Corp\",\n \"contactName\": \"John Doe\",\n \"street1\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"US\",\n \"email\": \"shipping@acme.com\",\n \"phone\": \"555-1234\",\n \"carrier\": \"UPS\",\n \"carrierService\": \"Ground\",\n \"shipmentCost\": 15.00,\n \"shipmentPrice\": 25.00,\n \"trackingPackages\": []\n }\n ],\n \"VirtualProofs\": [],\n \"purchaseOrderEmails\": []\n }\n ],\n \"ShipmentArray\": [],\n \"Documents\": [],\n \"Payments\": [\n {\n \"_id\": \"507f1f77bcf86cd799439060\",\n \"type\": \"Credit Card\",\n \"amount\": 500.00,\n \"currency\": \"USD\",\n \"createdDate\": \"2025-11-07T10:30:00.000Z\",\n \"userId\": \"507f1f77bcf86cd799439013\"\n }\n ],\n \"discountCodes\": [],\n \"referenceFields\": [],\n \"trackingPackages\": [],\n \"fullFilmentLogs\": [],\n \"orderDevice\": {\n \"browser\": \"Chrome\",\n \"os\": \"Windows\",\n \"device\": \"Desktop\"\n },\n \"utm\": {\n \"utmSource\": \"google\",\n \"utmMedium\": \"cpc\",\n \"utmCampaign\": \"fall-2025\"\n },\n \"createdAt\": \"2025-11-07T10:30:00.000Z\",\n \"updatedAt\": \"2025-11-07T14:20:00.000Z\"\n}\n\n{\n \"message\": \"Order not found!\"\n}\n\nCauses:
\nOrder doesn't exist
\nOrder has been soft deleted
\nUser doesn't have access to this order's distributor
\nTest order without proper access
\nNon-admin portal users can only access orders from their own distributor
\nAdmin portal users can access orders across distributors
\nTest orders (isTest: true) are automatically filtered unless:
Request includes portal header
Request includes storeid header
Query parameter withTestOrders is true
If user has a supplierId, only purchase orders for that supplier are returned
Useful for supplier portal access
\nThis endpoint returns the most complete order data available, including:
\n✅ All nested purchase orders with line items, parts, and decorations
\n✅ Complete customer information with company and addresses
\n✅ Store and distributor details
\n✅ All team members (sales, admin, created by)
\n✅ Product details with supplier information
\n✅ Shipment tracking information
\n✅ Payment records (admin only)
\n✅ Order history and logs
\n✅ Uploaded documents
\n✅ Artwork proofs
\n✅ UTM tracking data
\n✅ Device information
\nWhen isPrivate: true (which it is for this endpoint):
Payment information is included
\nSensitive store settings are hidden
\nPromoStandards credentials are excluded
\nOrder detail views in admin portal
\nCustomer order history detail page
\nOrder editing preparation
\nInvoice generation
\nFulfillment processing
\nOrder reports with complete data
\nMethod: POST or GET
URL: https://api.mpowerpromo.com/load-orders
Authentication: Required (JWT Bearer token)
API Token Access: Supported
Note: POST method is preferred when sending complex filter parameters in the request body.
\nThe request body should contain a params object with filter, pagination, and population options:
{\n \"params\": {\n \"filter\": {},\n \"page\": 1,\n \"limit\": 25,\n \"ascending\": 0,\n \"orderBy\": \"createdAt\",\n \"populate\": [],\n \"fields\": []\n }\n}\n\nAll these go inside the filter object:
{\n \"params\": {\n \"page\": 1,\n \"limit\": 25,\n \"ascending\": 0,\n \"orderBy\": \"createdAt\"\n }\n}\n\n{\n \"params\": {\n \"filter\": {\n \"orderStatus\": [\"Processing\", \"In Production\", \"Shipped\"]\n },\n \"page\": 1,\n \"limit\": 50,\n \"ascending\": 0,\n \"orderBy\": \"updatedAt\"\n }\n}\n\n{\n \"params\": {\n \"filter\": {\n \"sales\": [\n {\"val\": \"507f1f77bcf86cd799439011\"}\n ]\n },\n \"page\": 1,\n \"limit\": 25\n }\n}\n\n{\n \"params\": {\n \"query\": \"12345\",\n \"page\": 1,\n \"limit\": 25\n }\n}\n\n{\n \"params\": {\n \"filter\": {\n \"createdAt\": {\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2025-12-31\"\n }\n },\n \"orderDateRange\": {\n \"startDate\": \"2025-10-01\",\n \"endDate\": \"2025-10-31\"\n },\n \"page\": 1,\n \"limit\": 50\n }\n}\n\n{\n \"params\": {\n \"filter\": {\n \"rushOrder\": [{\"name\": \"Yes\"}],\n \"orderStatus\": [\"Processing\", \"In Production\"]\n },\n \"withPayments\": true,\n \"page\": 1,\n \"limit\": 25,\n \"ascending\": 0,\n \"orderBy\": \"dueDate\"\n }\n}\n\n{\n \"params\": {\n \"filter\": {\n \"storeId\": [\"507f1f77bcf86cd799439011\"],\n \"purchaseOrdersSuppliers\": [\"507f1f77bcf86cd799439020\"]\n },\n \"withSupplier\": true,\n \"page\": 1,\n \"limit\": 25\n }\n}\n\n{\n \"params\": {\n \"filter\": {\n \"orderStatus\": [\"Processing\", \"Shipped\"],\n \"orderType\": [\"Decorated\"],\n \"sales\": [{\"val\": \"507f1f77bcf86cd799439011\"}],\n \"firmDueDate\": [{\"name\": \"Yes\"}],\n \"createdAt\": {\n \"startDate\": \"2025-11-01\",\n \"endDate\": \"2025-11-30\"\n }\n },\n \"withPayments\": true,\n \"withSupplier\": true,\n \"withDistributor\": true,\n \"withReferenceFields\": true,\n \"page\": 1,\n \"limit\": 50,\n \"ascending\": 1,\n \"orderBy\": \"orderId\"\n }\n}\n\n{\n \"params\": {\n \"filter\": {\n \"orderStatus\": [\"Processing\"]\n },\n \"fields\": [\n \"orderId\",\n \"orderStatus\",\n \"orderTotal\",\n \"customerId\",\n \"dueDate\",\n \"createdAt\"\n ],\n \"page\": 1,\n \"limit\": 100\n }\n}\n\n{\n \"params\": {\n \"filter\": {\n \"orderStatus\": [\"Completed\"],\n \"orderDateRange\": {\n \"startDate\": \"2025-10-01\",\n \"endDate\": \"2025-10-31\"\n }\n },\n \"exportFormat\": \"csv\",\n \"exportFields\": [\n \"orderId\",\n \"orderStatus\",\n \"orderTotal\",\n \"orderDate\",\n \"customerId.firstName\",\n \"customerId.lastName\"\n ]\n }\n}\n\n{\n \"params\": {\n \"filter\": {\n \"orderStatus\": [\"New Quote Request\"]\n },\n \"onlyCount\": true\n }\n}\n\n{\n \"params\": {\n \"filter\": {},\n \"excludeTestOrders\": true,\n \"excludeStatuses\": [\"Deleted\", \"Canceled\"],\n \"page\": 1,\n \"limit\": 25\n }\n}\n\n{\n \"params\": {\n \"filter\": {\n \"orderStatus\": [\"Processing\", \"In Production\"],\n \"orderType\": [\"Decorated\"],\n \"sales\": [{\"val\": \"507f1f77bcf86cd799439011\"}],\n \"admin\": [{\"val\": \"507f1f77bcf86cd799439012\"}],\n \"storeId\": [\"507f1f77bcf86cd799439014\"],\n \"rushOrder\": [{\"name\": \"Yes\"}],\n \"firmDueDate\": [{\"name\": \"Yes\"}],\n \"createdAt\": {\n \"startDate\": \"2025-11-01\",\n \"endDate\": \"2025-11-30\"\n }\n },\n \"excludeTestOrders\": true,\n \"excludeStatuses\": [\"Deleted\", \"Canceled\", \"Archive\"],\n \"withPayments\": true,\n \"withSupplier\": true,\n \"withDistributor\": true,\n \"withPurchaseOrders\": true,\n \"withDocuments\": true,\n \"withReferenceFields\": true,\n \"totalStores\": true,\n \"page\": 1,\n \"limit\": 50,\n \"ascending\": 0,\n \"orderBy\": \"createdAt\"\n }\n}\n\n{\n \"data\": [\n {\n \"_id\": \"507f1f77bcf86cd799439050\",\n \"orderId\": 12345,\n \"orderStatus\": \"Processing\",\n \"orderType\": \"Decorated\",\n \"initialType\": \"New Quote Request\",\n \"orderTotal\": 1250.00,\n \"balance\": 625.00,\n \"dueDate\": \"12/31/2025\",\n \"rushOrder\": true,\n \"firmDueDate\": true,\n \"isFlagged\": false,\n \"source\": \"app\",\n \"customerId\": {\n \"_id\": \"507f1f77bcf86cd799439012\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john@example.com\"\n },\n \"storeId\": {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"storeName\": \"Acme Promo\"\n },\n \"salesUserId\": {\n \"_id\": \"507f1f77bcf86cd799439013\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Sales\"\n },\n \"adminUserId\": {\n \"_id\": \"507f1f77bcf86cd799439014\",\n \"firstName\": \"Admin\",\n \"lastName\": \"User\"\n },\n \"PurchaseOrders\": [],\n \"createdAt\": \"2025-11-07T10:30:00.000Z\",\n \"updatedAt\": \"2025-11-07T14:20:00.000Z\"\n }\n ],\n \"count\": 1,\n \"totalStores\": [\n {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"count\": 150,\n \"store\": {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"storeName\": \"Acme Promo\"\n }\n }\n ],\n \"referenceFields\": []\n}\n\n{\n \"count\": 150\n}\n\n{\n \"progress\": 0.45\n}\n\nUsers automatically see only orders from their distributor
\nSuper admins can use allDistributors filter
Use viewAllDistributorCustomerOrder with proper permissions
Supplier users only see orders with POs assigned to them
\nUse withProductionPurchaseOrders: true for supplier filtering
Automatically excluded unless:
\nwithTestOrders: true is set
portal or storeid header is present
The query parameter searches across:
Order ID (numeric match)
\nOrder total (price match)
\nCustomer name, email, company
\nStore name
\nReference field values
\ncreatedAt dates: ISO 8601 strings (\"2025-11-07\")
orderDateRange dates: ISO 8601 strings (\"2025-11-07\")
Results include both web and server-side formatted dates
\nCommon orderBy values:
\"createdAt\" - Creation date (default)
\"updatedAt\" - Last updated
\"orderId\" - Order number
\"dueDate\" - Due date
\"orderTotal\" - Total amount
\"customerId.firstName\" - Customer name
\"salesUserId.firstName\" - Sales rep name
\"storeId.storeName\" - Store name
When exportFormat is specified:
First request initiates export (returns progress)
\nSubsequent requests check progress
\nUse progress header to check status
Export completes when progress reaches 1.0
\n{\n \"data\": [],\n \"count\": 0\n}\n\nCauses:
\nNo orders match filters
\nUser doesn't have access to any orders
\nCauses:
\nOrder list views in admin portal
\nCustomer order history lists
\nSales dashboard filtered by rep
\nStore order reports
\nProduction queue for suppliers
\nOrder exports for accounting
\nAnalytics and reporting
\nUse limit wisely - max is 100
Request only needed fields with fields parameter
Avoid unnecessary population - only set with\\\\\\\\* flags you need
Use specific filters instead of broad searches
\nCache frequently accessed lists
\nMethod: POST
URL: https://api.mpowerpromo.com/orders
Authentication: Required (JWT Bearer token)
API Token Access: Supported
Each item in the PurchaseOrders array can contain:
Each item in the ShipmentArray can contain:
{\n \"order\": {\n \"storeId\": \"507f1f77bcf86cd799439011\",\n \"customerId\": \"507f1f77bcf86cd799439012\",\n \"orderEmail\": \"customer@example.com\",\n \"currency\": \"USD\",\n \"currencyRate\": 1,\n \"PurchaseOrders\": []\n },\n \"status\": \"New Quote Request\"\n}\n\n{\n \"order\": {\n \"storeId\": \"507f1f77bcf86cd799439011\",\n \"orderEmail\": \"customer@example.com\",\n \"dueDate\": \"12/31/2025\",\n \"rushOrder\": false,\n \"firmDueDate\": true,\n \"allowCreditCardPayments\": true,\n \"allowECheckPayments\": false,\n \"currency\": \"USD\",\n \"currencyRate\": 1,\n \"PurchaseOrders\": []\n },\n \"customer\": {\n \"_id\": \"507f1f77bcf86cd799439012\",\n \"userId\": \"507f1f77bcf86cd799439013\",\n \"adminUserId\": \"507f1f77bcf86cd799439014\"\n },\n \"status\": \"Quote In Progress\"\n}\n\n{\n \"order\": {\n \"storeId\": \"507f1f77bcf86cd799439011\",\n \"customerId\": \"507f1f77bcf86cd799439012\",\n \"orderEmail\": \"customer@example.com\",\n \"customerCompany\": \"507f1f77bcf86cd799439015\",\n \"salesUserId\": \"507f1f77bcf86cd799439013\",\n \"adminUserId\": \"507f1f77bcf86cd799439014\",\n \"productTotal\": 500.00,\n \"productTotalCost\": 325.00,\n \"chargeTotal\": 50.00,\n \"chargeTotalCost\": 30.00,\n \"taxTotal\": 0,\n \"shippingTotal\": 25.00,\n \"discountTotal\": 0,\n \"orderDiscount\": 0,\n \"productMargin\": 35,\n \"rushOrder\": false,\n \"isFlagged\": false,\n \"firmDueDate\": true,\n \"dueDate\": \"12/31/2025\",\n \"allowCreditCardPayments\": true,\n \"allowECheckPayments\": true,\n \"currency\": \"USD\",\n \"currencyRate\": 1,\n \"PurchaseOrders\": [\n {\n \"status\": \"New\",\n \"type\": \"Standard\",\n \"supplier\": \"507f1f77bcf86cd799439020\",\n \"productId\": \"PROD-001\",\n \"productTotal\": 500.00,\n \"productTotalCost\": 325.00,\n \"chargeTotal\": 50.00,\n \"chargeTotalCost\": 30.00,\n \"total\": 575.00,\n \"dueDate\": \"12/31/2025\",\n \"LineItemArray\": [],\n \"ChargeArray\": [],\n \"ShipmentArray\": []\n }\n ],\n \"ShipmentArray\": [\n {\n \"companyName\": \"Acme Corp\",\n \"contactName\": \"John Doe\",\n \"street1\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"US\",\n \"email\": \"shipping@example.com\",\n \"phone\": \"555-1234\",\n \"carrier\": \"UPS\",\n \"carrierService\": \"Ground\",\n \"shipmentCost\": 15.00,\n \"shipmentPrice\": 25.00\n }\n ],\n \"discountCodes\": [],\n \"referenceFields\": []\n },\n \"status\": \"Quote In Progress\"\n}\n\n{\n \"order\": {\n \"orderId\": 12345,\n \"storeId\": \"507f1f77bcf86cd799439011\",\n \"customerId\": \"507f1f77bcf86cd799439012\",\n \"PurchaseOrders\": []\n },\n \"isDuplicate\": true,\n \"followUpDetails\": \"Customer requested reorder with same specifications\",\n \"status\": \"New Quote Request\"\n}\n\n{\n \"order\": {\n \"orderId\": 12345,\n \"storeId\": \"507f1f77bcf86cd799439011\",\n \"customerId\": \"507f1f77bcf86cd799439012\",\n \"PurchaseOrders\": []\n },\n \"isDuplicate\": true,\n \"duplicatedPO\": 1,\n \"followUpDetails\": \"Customer wants to reorder only PO #1\",\n \"status\": \"New Quote Request\"\n}\n\nReturns the complete created order object with:
\nAuto-generated orderId (numeric)
Auto-assigned salesUserId and adminUserId (if not provided)
Created createdDate timestamp
Populated PurchaseOrders with friendlyPurchaseOrderDetailId values
Auto-calculated totals
\nCreated order follow-up record
\n{\n \"_id\": \"507f1f77bcf86cd799439050\",\n \"orderId\": 12346,\n \"storeId\": \"507f1f77bcf86cd799439011\",\n \"customerId\": \"507f1f77bcf86cd799439012\",\n \"orderStatus\": \"New Quote Request\",\n \"salesUserId\": \"507f1f77bcf86cd799439013\",\n \"adminUserId\": \"507f1f77bcf86cd799439014\",\n \"createdByUserId\": \"507f1f77bcf86cd799439013\",\n \"createdDate\": \"2025-11-07T10:30:00.000Z\",\n \"productTotal\": 500.00,\n \"total\": 0,\n \"PurchaseOrders\": [],\n \"createdAt\": \"2025-11-07T10:30:00.000Z\",\n \"updatedAt\": \"2025-11-07T10:30:00.000Z\"\n}\n\n{\n \"message\": \"Error description\"\n}\n\nCommon Error Messages:
\n\"User is not authorized to create orders for this distributor.\" (403)
\"Recaptcha token is invalid!\" (400)
\"Store not found\" (500)
Order creation validation errors (500)
\nFields Auto-Set by API (don't include in request):
\norderId - Auto-generated sequence number
createdByUserId - Set from authenticated user
distributorId - Set from authenticated user
createdBy - Set from authenticated user
createdDate - Set to current UTC time
total - Calculated from order items
Fields Removed if Present:
\norderId (in order object) - Conflicts with auto-generation
_id - MongoDB handles this
orderDate - Set when order is completed
If not provided, salesUserId and adminUserId are assigned based on:
Store's sales strategy (Round-rolling, etc.)
\nCustomer's assigned user IDs
\nFalls back to the creating user
\nWhen isDuplicate: true:
Purchase orders are duplicated with new IDs
\nShipment information is cleared
\nA \"Reorder Request\" follow-up is created
\nOriginal order ID is logged in changes
\nMust have JWT authentication
\nUser must belong to the same distributor as the store
\nSuper admins can create orders for any distributor
\n\"New Quote Request\"
\"Quote In Progress\"
\"Quote Sent\"
\"Pending Payment\"
\"Processing\"
\"Sent to Supplier\"
\"In Production\"
\"Proof Pending Approval\"
\"Shipped\"
\"Delivered\"
\"Completed\"
\"Canceled\"
\"On Hold\"
Method: PUT
URL: https://api.mpowerpromo.com/orders/{{orderId}}/edit
Authentication: Required (JWT Bearer token)
API Token Access: Supports API token authentication
Important: This endpoint uses the numeric orderId, not the MongoDB _id.
These fields are automatically removed or managed:
\n❌ orderId - Cannot be changed (path parameter)
❌ createdBy - Removed from body
❌ updatedAt - Auto-updated
PUT https://api.mpowerpromo.com/orders/12345/edit\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"orderStatus\": \"Processing\"\n}\n\nPUT https://api.mpowerpromo.com/orders/12345/edit\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"salesUserId\": \"507f1f77bcf86cd799439011\",\n \"adminUserId\": \"507f1f77bcf86cd799439012\"\n}\n\nPUT https://api.mpowerpromo.com/orders/12345/edit\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"orderDate\": \"2025-10-28\"\n}\n\nPUT https://api.mpowerpromo.com/orders/12345/edit\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"orderEmail\": \"customer@example.com\",\n \"dueDate\": \"11/30/2025\"\n}\n\nPUT https://api.mpowerpromo.com/orders/12345/edit\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"rushOrder\": true,\n \"firmDueDate\": true,\n \"isFlagged\": true\n}\n\nPUT https://api.mpowerpromo.com/orders/12345/edit\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"invoiceQBId\": \"QB-INV-12345\",\n \"customerQBId\": \"QB-CUST-67890\",\n \"orderZohoId\": \"ZOHO-ORD-11111\"\n}\n\nPUT https://api.mpowerpromo.com/orders/12345/edit\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"isTest\": true\n}\n\nPUT https://api.mpowerpromo.com/orders/12345/edit\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"orderDiscount\": 50.00\n}\n\nPUT https://api.mpowerpromo.com/orders/12345/edit\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"taxTotal\": 0\n}\n\nPUT https://api.mpowerpromo.com/orders/12345/edit\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"orderStatus\": \"Shipped\",\n \"completedDate\": \"2025-10-28\",\n \"rushOrder\": false,\n \"salesUserId\": \"507f1f77bcf86cd799439011\",\n \"orderEmail\": \"updated@example.com\"\n}\n\nReturns the updated order object:
\n{\n \"_id\": \"507f1f77bcf86cd799439999\",\n \"orderId\": 12345,\n \"orderStatus\": \"Processing\",\n \"orderType\": \"Standard\",\n \"orderDate\": \"2025-10-28\",\n \"orderTotal\": 1250.50,\n \"productTotal\": 1000.00,\n \"taxTotal\": 100.50,\n \"shippingTotal\": 150.00,\n \"balance\": 0,\n \"customerId\": \"507f1f77bcf86cd799439011\",\n \"storeId\": \"507f1f77bcf86cd799439012\",\n \"distributorId\": \"507f1f77bcf86cd799439013\",\n \"salesUserId\": \"507f1f77bcf86cd799439014\",\n \"admin UserId\": \"507f1f77bcf86cd799439015\",\n \"isTest\": false,\n \"rushOrder\": false,\n \"isFlagged\": false,\n \"PurchaseOrders\": [],\n \"createdAt\": \"2025-10-01T09:00:00.000Z\",\n \"updatedAt\": \"2025-10-28T15:30:00.000Z\"\n}\n\n{\n \"message\": \"Order not found\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\n{\n \"message\": \"Validation failed\",\n \"errors\": []\n}\n\nAll changes are automatically tracked
\nCreates detailed diff of before/after state
\nLogs to Log collection with category ORDER_UPDATES
Includes IP address, user ID, and timestamp
\nSends CART_UPDATED_FRESH event via WebSocket
Notifies connected clients of order updates
\nReal-time updates for order management UI
\nLogs all API token-based requests
\nTracks which integration/API key made the change
\nAudits external system access
\nupdatedBy automatically set to current user
orderId and createdBy removed from request body
Cannot be changed via this endpoint
\nThis endpoint uses numeric orderId, not MongoDB _id
Example: Use 12345, not 507f1f77bcf86cd799439999
Only send fields you want to update
\nUnspecified fields remain unchanged
\nArrays are replaced entirely if provided
\nMost totals are auto-calculated from purchase orders
\nManual updates may be overwritten on next save
\nUse with caution
\nChanging status may trigger side effects
\nMay update virtual proofs, inventory, notifications
\nTest in development environment first
\nChanges may auto-sync to QuickBooks, Zoho, HubSpot
\nSync happens asynchronously after update
\nCheck sync status in response or logs
\nField,Description,Required,Data Type,Updatable\norderStatus,Order status,No,String,Yes\norderType,Order type,No,String,Yes\norderDate,Order date,No,DateOnly,Yes\ncompletedDate,Completion date,No,DateOnly,Yes\ndueDate,Due date,No,String,Yes\norderEmail,Customer email,No,String,Yes\ncustomerId,Customer reference,No,ObjectId,Yes\nstoreId,Store reference,No,ObjectId,Yes\ndistributorId,Distributor reference,No,ObjectId,Yes\nsalesUserId,Sales user,No,ObjectId,Yes\nadminUserId,Admin user,No,ObjectId,Yes\norderTotal,Total amount,No,Number,Yes (auto-calc)\nproductTotal,Product total,No,Number,Yes (auto-calc)\ntaxTotal,Tax total,No,Number,Yes\nshippingTotal,Shipping total,No,Number,Yes (auto-calc)\norderDiscount,Order discount,No,Number,Yes\ninvoiceQBId,QuickBooks invoice ID,No,String,Yes\norderZohoId,Zoho order ID,No,String,Yes\norderHubspotId,HubSpot order ID,No,String,Yes\nisTest,Test flag,No,Boolean,Yes\nrushOrder,Rush flag,No,Boolean,Yes\nisFlagged,Flagged status,No,Boolean,Yes\norderId,Order ID (numeric),No,Number,No (path param)\ncreatedBy,Creator,No,ObjectId,No (auto-removed)\n\nUse Numeric Order ID: Always use the numeric orderId, not MongoDB _id
Partial Updates: Only include fields you're changing
\nTest Mode: Use isTest: true for testing integrations
Status Transitions: Follow proper status flow (Pending → Processing → Shipped)
\nValidation: Validate data before sending to avoid errors
\nLogging: All changes are logged - ensure proper user context
\nReal-time Updates: Changes trigger socket events for UI updates
\nExternal Sync: Be aware changes may sync to external systems
\nMethod: DELETE
URL: https://api.mpowerpromo.com/orders/{{orderId}}
Authentication: Required (JWT Bearer token)
API Token Access: Supported
Important: This is a soft delete - the order is not permanently removed from the database. Instead, it is marked as deleted with a timestamp and reason.
\nNote: This endpoint uses the numeric orderId, not the MongoDB _id.
No request body required - this is a simple DELETE operation.
\nThe order record is updated with:
\ndeletedAt: Current timestamp
deletedBy: User ID who deleted the order
orderStatus: Changed to \"Deleted\"
deletedReason: Set to \"User deleted. {user_email}\"
All associated follow-up records are also soft deleted:
\nOrderFollowUp records linked to this order get a deletedAt timestampIf socket connections are active, a cart update notification is broadcast.
\nIf the request used an API token, the action is logged for tracking.
\nReturns the deleted order object with updated fields:
\n{\n \"_id\": \"507f1f77bcf86cd799439050\",\n \"orderId\": 12345,\n \"orderStatus\": \"Deleted\",\n \"orderType\": \"Decorated\",\n \"orderEmail\": \"customer@example.com\",\n \"customerId\": \"507f1f77bcf86cd799439012\",\n \"storeId\": \"507f1f77bcf86cd799439011\",\n \"salesUserId\": \"507f1f77bcf86cd799439013\",\n \"adminUserId\": \"507f1f77bcf86cd799439014\",\n \"productTotal\": 1250.00,\n \"orderTotal\": 1425.00,\n \"deletedAt\": \"2025-11-07T14:30:00.000Z\",\n \"deletedBy\": \"507f1f77bcf86cd799439013\",\n \"deletedReason\": \"User deleted. admin@company.com\",\n \"PurchaseOrders\": [],\n \"createdAt\": \"2025-11-07T10:30:00.000Z\",\n \"updatedAt\": \"2025-11-07T14:30:00.000Z\"\n}\n\ncurl --location --request DELETE 'https://api.mpowerpromo.com/orders/12345' \\\n--header 'Authorization: Bearer {{token}}'\n\nMethod: DELETE
URL: https://api.mpowerpromo.com/orders/12345
Headers:
Authorization: Bearer {{token}}\n\nBody: None
\nconst axios = require('axios');\naxios.delete('https://api.example.com/orders/12345', {\n headers: {\n 'Authorization': 'Bearer YOUR_TOKEN_HERE'\n }\n})\n.then(response => {\n console.log('Order deleted:', response.data);\n})\n.catch(error => {\n console.error('Error deleting order:', error.response.data);\n});\n\n{\n \"message\": \"Order not found\"\n}\n\nCauses:
\nOrder doesn't exist
\nInvalid orderId format
\nOrder already deleted
\n{\n \"message\": \"Unauthorized\"\n}\n\nCauses:
\nMissing authentication token
\nInvalid authentication token
\nExpired token
\nCauses:
\nUser doesn't have permission to delete orders
\nUser doesn't belong to the order's distributor
\nAPI token doesn't have delete permissions
\n✅ Soft Delete: Order remains in database
\n✅ Can be restored: Use the un-delete endpoint
\n✅ Audit trail: Deletion is tracked with timestamp, user, and reason
\n❌ Not immediately removed: Order still exists in database
\n❌ Won't appear in normal queries: Queries filter out deleted orders by default
\nThe following remain unchanged:
\nCustomer record
\nStore record
\nPayment records
\nDocuments/uploads
\nLogs and history
\nRelated data in other systems (QB, Zoho, etc.)
\nYou can restore a deleted order using:
\nMethod: POST
URL: https://api.mpowerpromo.com/orders/{{_id}}/un-delete
Note: This uses the MongoDB _id, not the numeric orderId.
curl --location --request POST 'https://api.mpowerpromo.com/orders/507f1f77bcf86cd799439050/un-delete' \\\n--header 'Authorization: Bearer {{token}}'\n\nResponse:
\n{\n \"_id\": \"507f1f77bcf86cd799439050\",\n \"orderId\": 12345,\n \"orderStatus\": \"Deleted\",\n \"cancelDeletedAt\": \"2025-11-07T15:00:00.000Z\"\n}\n\nNote: The deletedAt field is removed, and cancelDeletedAt is set to track the restoration.
To view deleted orders in the load-orders endpoint:
\n{\n \"params\": {\n \"deletedOnly\": true,\n \"page\": 1,\n \"limit\": 25\n }\n}\n\nMust be authenticated
\nMust have access to the order's distributor
\nAPI tokens must have delete permissions enabled
\n✅ Admin users
\n✅ Sales users (for their own orders)
\n✅ Users with proper role permissions
\n✅ API tokens with delete access
\n❌ Customers cannot delete orders
\nOrder created by mistake
\nDuplicate order entry
\nTest order cleanup
\nCustomer canceled before processing
\nOrder entered in wrong system
\n❌ Completed orders - Use \"Canceled\" status instead
\n❌ Orders with payments - Refund first, then delete
\n❌ Orders in production - Cancel with supplier first
\n❌ Shipped orders - Use appropriate status instead
\nCheck order status - Ensure it's safe to delete
\nVerify with team - Confirm no one is working on it
\nDocument reason - The deletion reason is auto-generated but you may want to add a note
\nCheck for payments - Handle any payments appropriately
\nNotify stakeholders - Customer, supplier, etc.
\nVerify deletion - Check the response confirms deletion
\nNotify team - Let relevant team members know
\nUpdate external systems - If integrated with QB, Zoho, etc.
\nDocument - Add notes if needed for audit purposes
\nRecommendation: Use Cancel status for normal business operations. Use Delete only for data cleanup and errors.
\n// 1. Get the order to verify it exists\nconst order = await axios.get('https://api.mpowerpromo.com/orders/12345/full', {\n headers: { Authorization: 'Bearer {{token}}' }\n});\nconsole.log(`Deleting order ${order.data.orderId} - ${order.data.orderStatus}`);\n// 2. Delete the order\nconst deletedOrder = await axios.delete('https://api.mpowerpromo.com/orders/12345', {\n headers: { Authorization: 'Bearer {{token}}' }\n});\nconsole.log(`Order deleted at: ${deletedOrder.data.deletedAt}`);\nconsole.log(`Deleted by: ${deletedOrder.data.deletedBy}`);\nconsole.log(`Reason: ${deletedOrder.data.deletedReason}`);\n// 3. Verify deletion\nconst orders = await axios.post('https://api.mpowerpromo.com/load-orders', {\n params: {\n filter: { orderId: 12345 }\n }\n}, {\n headers: { Authorization: 'Bearer {{token}}' }\n});\nconsole.log(`Order visible in normal queries: ${orders.data.data.length > 0}`);\n// 4. Check deleted orders list\nconst deletedOrders = await axios.post('https://api.mpowerpromo.com/load-orders', {\n params: {\n deletedOnly: true,\n filter: { orderId: 12345 }\n }\n}, {\n headers: { Authorization: 'Bearer {{token}}' }\n});\nconsole.log(`Order in deleted list: ${deletedOrders.data.data.length > 0}`)\n\nGet purchase orders.
\n","urlObject":{"path":["load-purchase-orders"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d4490aa0-d4e3-4d1a-8457-90564f3b8ba3"},{"name":"Get Order POs","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"purchaseOrderId\", jsonData[0].friendlyPurchaseOrderDetailId); "],"type":"text/javascript","packages":{}}}],"id":"e36d8712-eadb-49c3-a7e3-f857e93765f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/orders/{{orderId}}/details","description":"Get order
\nOptional Params
\n","urlObject":{"path":["orders","{{orderId}}","details"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e36d8712-eadb-49c3-a7e3-f857e93765f7"},{"name":"Get Order PO","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","\r","// postman.setEnvironmentVariable(\"order_id\", jsonData._id); \r","\r","pm.test(\"Response status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","\r","pm.test(\"Response time is less than 200ms\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(200);\r","});\r","\r","\r","pm.test(\"Verify that the response is in JSON format\", function () {\r"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\r","});\r","\r","\r","pm.test(\"Status is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Content type is application/json\", function () {\r"," pm.response.to.have.header(\"Content-Type\", \"application/json\");\r","});\r","\r","pm.test(\"Check for the presence of required fields\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData).to.be.an('object');\r"," pm.expect(responseData).to.have.property('fromPOId');\r"," pm.expect(responseData).to.have.property('childOrderId');\r"," pm.expect(responseData).to.have.property('productTotal');\r"," pm.expect(responseData).to.have.property('supplier');\r"," pm.expect(responseData).to.have.property('LineItemArray');\r"," pm.expect(responseData).to.have.property('ShipmentArray');\r"," pm.expect(responseData).to.have.property('relatedPO');\r"," pm.expect(responseData).to.have.property('grouped');\r","});\r","\r","\r","pm.test(\"LineItemArray contains the expected number of elements\", function () {\r"," const responseData = pm.response.json();\r"," \r"," pm.expect(responseData.LineItemArray).to.be.an('array');\r"," pm.expect(responseData.LineItemArray).to.have.lengthOf(1);\r","});\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"688e09e9-37a3-49b8-b198-cf69eb0395c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/orders/{{orderId}}/details/{{friendlyPurchaseOrderDetailId}}","description":"Get order PO
\n","urlObject":{"path":["orders","{{orderId}}","details","{{friendlyPurchaseOrderDetailId}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"688e09e9-37a3-49b8-b198-cf69eb0395c9"},{"name":"Update Order PO","id":"a24cccee-bcfb-467a-9c41-25f7ba99e6ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"{\r\n \"status\": \"In Production\",\r\n \"prevStatus\": \"Sent to Supplier\",\r\n \"type\": \"Standard\",\r\n \"supplier\": \"507f1f77bcf86cd799439011\",\r\n \"supplierCode\": \"ABC-12345\",\r\n \"productId\": \"PROD-001\",\r\n \"SO\": \"1234\",\r\n \"source\": \"PromoStandards API\",\r\n \"requestedBy\": \"Email\",\r\n \"rush\": true,\r\n \"taxExempt\": false,\r\n \"hideLogo\": false,\r\n \"fromProductView\": false,\r\n \"availableStatusToCheck\": true,\r\n \"productTotal\": 1000.00,\r\n \"productTotalCost\": 650.00,\r\n \"margin\": 350.00,\r\n \"total\": 1315.00,\r\n \"shippingTotal\": 50.00,\r\n \"shippingTotalCost\": 35.00,\r\n \"chargeTotal\": 150.00,\r\n \"chargeTotalCost\": 100.00,\r\n \"discountTotal\": 100.00,\r\n \"adjustmentsTotal\": 25.00,\r\n \"productDiscount\": 100.00,\r\n \"shippingDiscount\": 25.00,\r\n \"taxTotal\": 115.00,\r\n \"taxRate\": 10.0,\r\n \"partFundraisingTotal\": 200.00,\r\n \"estimatedDeliveryDate\": \"11/20/2025\",\r\n \"estimatedProductionDate\": \"11/5/2025\",\r\n \"estimatedShipDate\": \"11/15/2025\",\r\n \"receivedDate\": \"10/28/2025\",\r\n \"dueDate\": \"11/25/2025\",\r\n \"shippedDate\": \"11/16/2025\",\r\n \"reconciledAt\": \"2025-10-28T15:30:00.000Z\",\r\n \"shippingReconciliationAt\": 20251028,\r\n \"supplierReconciliationAt\": 20251028,\r\n \"lastCheckedTrackingDate\": \"2025-10-28T10:00:00.000Z\",\r\n \"hasSupplierReconciliationDate\": true,\r\n \"hasShippingReconciliationDate\": true,\r\n \"updateReconciled\": false,\r\n \"publicComments\": \"Thank you for your order! Expected delivery: November 20th, 2025.\",\r\n \"privateComments\": \"VIP customer - priority handling required. Account manager: Jane Smith.\",\r\n \"billingComments\": \"Approved for Net 30 payment terms. PO#12345 on file.\",\r\n \"supplierComments\": \"Rush order - expedite through all production stages. Use premium materials.\",\r\n \"additionalSupplierComments\": \"Customer is very particular about color matching. Use PMS color guide.\",\r\n \"externalComments\": \"Referred by ABC Corporation partnership program.\",\r\n \"customerComments\": {\r\n \"decorationColors\": \"Pantone 186C Red, Pantone 280 Blue, Process Black\",\r\n \"instructions\": \"Left chest placement: 3 inch logo. Right sleeve: 1.5 inch text 'TEAM 2025'.\",\r\n \"dueDate\": \"11/20/2025\"\r\n },\r\n \"productionManagerId\": \"507f1f77bcf86cd799439012\",\r\n \"machine\": \"507f1f77bcf86cd799439013\",\r\n \"lineQBId\": \"LINE-12345\",\r\n \"qbProductsAndServicesId\": \"PROD-67890\",\r\n \"sync\": [\"QuickBooks\", \"Zoho\", \"HubSpot\"],\r\n \"syncIds\": [\"QB-12345\", \"ZOHO-67890\", \"HS-111222\"],\r\n \"parentPoId\": 100,\r\n \"fromPOId\": [95, 96],\r\n \"childOrderId\": [12346, 12347],\r\n \"batchedPO\": [2, 3, 4],\r\n \"promoCode\": \"VIP2025\",\r\n \"salesChannel\": \"Direct Sales\",\r\n \"updateGroup\": false,\r\n \"digitalProof\": {\r\n \"sentDate\": \"2025-10-28T10:00:00.000Z\",\r\n \"approvedDate\": \"2025-10-29T14:30:00.000Z\",\r\n \"proofUrl\": \"https://example.com/proofs/order-12345-po-1.pdf\"\r\n },\r\n \"shipment\": {\r\n \"_id\": \"507f1f77bcf86cd799439020\",\r\n \"carrier\": \"FedEx\",\r\n \"carrierService\": \"Ground\",\r\n \"trackingPackages\": [\"507f1f77bcf86cd799439021\"],\r\n \"shipmentCost\": 45.00,\r\n \"shipmentPrice\": 55.00,\r\n \"weight\": 12.5,\r\n \"attentionTo\": \"John Smith\",\r\n \"street1\": \"123 Business Park Drive\",\r\n \"street2\": \"Building B, Suite 200\",\r\n \"city\": \"Los Angeles\",\r\n \"state\": \"CA\",\r\n \"zip\": \"90001\",\r\n \"country\": \"US\",\r\n \"email\": \"john.smith@acme.com\",\r\n \"phone\": \"555-123-4567\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/orders/{{orderId}}/details/{{friendlyPurchaseOrderDetailId}}","description":"Method: PUT
URL: https://api.mpowerpromo.com/orders/{{orderId}}/details/{{friendlyPurchaseOrderDetailId}}
Authentication: Required (JWT Bearer token)
Status Values: Pending, Sent to Supplier, In Production, Shipped, Delivered, Canceled, Archive, Proof Sent, Proof Approved, Ready for Production, etc.
\nType Values: Standard, Sample, Blank, Decorator, etc.
\nExample:
\n{\n \"customerComments\": {\n \"decorationColors\": \"Pantone 186C Red, Process Black\",\n \"instructions\": \"Left chest placement, exact PMS color match required\",\n \"dueDate\": \"11/20/2025\"\n }\n}\n\nExample:
\n{\n \"shipment\": {\n \"_id\": \"507f1f77bcf86cd799439020\",\n \"carrier\": \"FedEx\",\n \"carrierService\": \"Overnight\",\n \"trackingPackages\": [\"507f1f77bcf86cd799439021\"],\n \"shipmentCost\": 45.00,\n \"shipmentPrice\": 55.00\n }\n}\n\nExample:
\n{\n \"digitalProof\": {\n \"sentDate\": \"2025-10-28T10:00:00.000Z\",\n \"approvedDate\": null,\n \"proofUrl\": \"https://example.com/proof/12345.pdf\"\n }\n}\n\nNote: This is a complex nested structure. Include only if updating entire line items.
\nRecommendation: Avoid sending LineItemArray unless you need to completely replace all line items. Use line-item-specific endpoints instead.
Note: For updating a single shipment, use the shipment field (see above). Only send ShipmentArray if replacing all shipments.
Recommendation: Use the shipment field to update individual shipments instead of replacing the entire array.
{\n \"status\": \"Sent to Supplier\"\n}\n\n{\n \"status\": \"Proof Approved\",\n \"updateGroup\": true\n}\n\n{\n \"supplierComments\": \"Rush order - please expedite\",\n \"privateComments\": \"Customer is VIP\"\n}\n\n{\n \"estimatedShipDate\": 20251115,\n \"estimatedDeliveryDate\": 20251120,\n \"dueDate\": 20251125\n}\n\n{\n \"productDiscount\": 100.00,\n \"shippingDiscount\": 25.00\n}\n\n{\n \"status\": \"Shipped\",\n \"shippedDate\": 20251028,\n \"supplierComments\": \"Shipped via FedEx - Tracking: 123456789\"\n}\n\n{\n \"rush\": true,\n \"status\": \"In Production\",\n \"privateComments\": \"Expedite - needed by Friday\"\n}\n\n{\n \"taxExempt\": true,\n \"taxTotal\": 0,\n \"taxRate\": 0\n}\n\nUpdate order. In post request provide the order object from getOrder request with updates
\n","urlObject":{"path":["orders","{{orderId}}","details"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7c9a04f-20c4-4298-83e4-3ead2fe459b8"},{"name":"Delete Order PO","event":[{"listen":"test","script":{"id":"b16f986b-fdba-4acb-a64d-b6b25539fd15","exec":[""],"type":"text/javascript","packages":{}}}],"id":"9c62bb43-0aa5-4928-8376-c0419323aeb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/orders/{{orderId}}/details/{{friendlyPurchaseOrderDetailId}}","description":"Update order. In post request provide the order object from getOrder request with updates
\n","urlObject":{"path":["orders","{{orderId}}","details","{{friendlyPurchaseOrderDetailId}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c62bb43-0aa5-4928-8376-c0419323aeb0"}],"id":"c3fdd46e-187e-4133-9643-1bde2603e3b0","_postman_id":"c3fdd46e-187e-4133-9643-1bde2603e3b0","description":""},{"name":"Products","item":[{"name":"Get Product","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","// postman.setEnvironmentVariable(\"order_id\", jsonData._id); "],"type":"text/javascript","packages":{}}}],"id":"a0c43715-85aa-4e00-9135-525cfea3aba1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/products/{{productId}}/view","description":"Get product
\n","urlObject":{"path":["products","{{productId}}","view"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a0c43715-85aa-4e00-9135-525cfea3aba1"},{"name":"Get Products","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"productId\", jsonData.data[0]._id); "],"type":"text/javascript","packages":{}}}],"id":"bc48e732-8414-486e-86dd-0915d1a04efe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"{\n \"params\": {\n \"page\": 1,\n \"limit\": 24,\n \"categoriesCount\": true,\n \"categoriesToFilter\": [],\n \"facetsToFilter\": {},\n \"sortFilter\": {\n \"label\": \"Most Popular\",\n \"value\": -1,\n \"type\": \"popular\"\n }, \n \"showPriceRange\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/stores/{{storeId}}/store-products","description":"Get products
\n","urlObject":{"path":["stores","{{storeId}}","store-products"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc48e732-8414-486e-86dd-0915d1a04efe"},{"name":"Create Product","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"productId\", jsonData._id); "],"type":"text/javascript","packages":{}}}],"id":"1476f3a1-bbef-4416-a593-2dcec0f1c164","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"{\n \"supplierCode\": \"92366\",\n \"fobPoints\": [\n {\n \"_id\": \"5f075ba508861b49e07b1cd0\",\n \"country\": \"US\",\n \"state\": \"PA\",\n \"zip\": \"19123\",\n \"city\": \"PHILA\",\n \"name\": \"19123, PHILA, PA, US\"\n }\n ],\n \"cartButtons\": [],\n \"source\": \"Manual\",\n \"productName\": \"product name\",\n \"slug\": \"product-name-product id-92366\",\n \"productId\": \"product id\", \n \"status\": \"not active\", \n \"descriptions\": [],\n \"decorationProducts\": [],\n \"facets\": [],\n \"supplierId\": \"5f075ba208861b49e07b1472\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/products","description":"Create products
\n","urlObject":{"path":["products"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1476f3a1-bbef-4416-a593-2dcec0f1c164"},{"name":"Edit Product","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"productId\", jsonData.data[0]._id); "],"type":"text/javascript","packages":{}}}],"id":"d9889e38-51c0-4ef3-97ae-762df70b2f61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"{\n \"productName\": \"product name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/products/{{productId}}","description":"Edit product
\n","urlObject":{"path":["products","{{productId}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d9889e38-51c0-4ef3-97ae-762df70b2f61"},{"name":"Delete Product","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":[""],"type":"text/javascript","packages":{}}}],"id":"4ccafb24-885d-4a73-a52f-51b7d8cb920c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/products/{{productId}}","description":"Remove product
\n","urlObject":{"path":["products","{{productId}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4ccafb24-885d-4a73-a52f-51b7d8cb920c"}],"id":"0eda0493-f4d4-4855-822e-7b6960bbf394","_postman_id":"0eda0493-f4d4-4855-822e-7b6960bbf394","description":""},{"name":"Products Part","item":[{"name":"Get Product Part","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","// postman.setEnvironmentVariable(\"order_id\", jsonData._id); "],"type":"text/javascript","packages":{}}}],"id":"30c7ed55-21dd-4962-a605-debc608bc232","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/products/{{productId}}/parts/{{productPartId}}","description":"Get product
\n","urlObject":{"path":["products","{{productId}}","parts","{{productPartId}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"30c7ed55-21dd-4962-a605-debc608bc232"},{"name":"Get Product Parts","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"productId\", jsonData.data[0]._id); "],"type":"text/javascript","packages":{}}}],"id":"4fdf54f3-8236-449c-9fa6-32ace68de32f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"{\n \"params\": {\n \"page\": 1,\n \"limit\": 24,\n \"categoriesCount\": true,\n \"categoriesToFilter\": [],\n \"facetsToFilter\": {},\n \"sortFilter\": {\n \"label\": \"Most Popular\",\n \"value\": -1,\n \"type\": \"popular\"\n }, \n \"showPriceRange\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/products/{{productId}}/parts","description":"Get product parts
\n","urlObject":{"path":["products","{{productId}}","parts"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4fdf54f3-8236-449c-9fa6-32ace68de32f"},{"name":"Create Product Part","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"productPartId\", jsonData._id); "],"type":"text/javascript","packages":{}}}],"id":"eeece0a5-f7df-4c14-9f8e-7dab3a348602","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"{\n \"partGroup\": \"1\",\n \"colors\": [\n {\n \"name\": \"black\",\n \"hex\": \"\"\n }\n ],\n \"compress\": true,\n \"mediaList\": [],\n \"charge_prices\": [],\n \"pricing\": [],\n \"shippingPackages\": [],\n \"dimension\": {\n \"weight\": null,\n \"width\": null,\n \"height\": null,\n \"depth\": null\n },\n \"inventory\": {\n \"partInventories\": []\n },\n \"defaultPart\": false,\n \"partId\": \"984927\",\n \"partDescription\": \"Duralast Brake Poster (English)\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/products/{{productId}}/parts","description":"Create product part
\n","urlObject":{"path":["products","{{productId}}","parts"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"eeece0a5-f7df-4c14-9f8e-7dab3a348602"},{"name":"Edit Product Part","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"productId\", jsonData.data[0]._id); "],"type":"text/javascript","packages":{}}}],"id":"03424502-5d3d-4e4a-8156-2cdde3628e2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"{\n \"partId\": \"new part id\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/products/{{productId}}/parts/{{productPartId}}","description":"Create products
\n","urlObject":{"path":["products","{{productId}}","parts","{{productPartId}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"03424502-5d3d-4e4a-8156-2cdde3628e2f"},{"name":"Delete Product Part","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":[""],"type":"text/javascript","packages":{}}}],"id":"03db7ab0-d898-4700-8d72-c67d006158f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/products/{{productId}}/parts/{{productPartId}}","description":"Remove product part
\n","urlObject":{"path":["products","{{productId}}","parts","{{productPartId}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"03db7ab0-d898-4700-8d72-c67d006158f8"}],"id":"9034b1d9-f4c3-4cc9-b852-aad8d551d7c9","_postman_id":"9034b1d9-f4c3-4cc9-b852-aad8d551d7c9","description":""},{"name":"Customer","item":[{"name":"Get Customer","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","// postman.setEnvironmentVariable(\"order_id\", jsonData._id); "],"type":"text/javascript","packages":{}}}],"id":"17ef67ef-3a3f-42f2-a5ba-e8da4fe42827","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/customers/{{customerId}}","description":"Method: GET
URL: https://api.mpowerpromo.com/customers/{{customerId}}
Authentication: Required (JWT Bearer token)
None - This endpoint does not accept query parameters.
\nThese fields are explicitly excluded for security:
\n❌ password - Encrypted password
❌ passwordResetToken - Password reset token
❌ passwordOrigin - Original plain text password
GET https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: {{vault:bearer-token}}\n\n{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"customerId\": 12345,\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"jobTitle\": \"Marketing Manager\",\n \"isActive\": true,\n \"rank\": 5,\n \"source\": \"Web\",\n \"distributorId\": \"507f1f77bcf86cd799439012\",\n \"stores\": [\n \"507f1f77bcf86cd799439013\"\n ],\n \"companyId\": {\n \"_id\": \"507f1f77bcf86cd799439014\",\n \"companyName\": \"Acme Corporation\",\n \"photo\": \"https://s3.amazonaws.com/company-logo.png\",\n \"distributorId\": \"507f1f77bcf86cd799439012\",\n \"referenceFields\": {},\n \"notes\": \"\"\n },\n \"userId\": {\n \"_id\": \"507f1f77bcf86cd799439015\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"photo\": \"https://s3.amazonaws.com/user-photo.png\"\n },\n \"adminUserId\": {\n \"_id\": \"507f1f77bcf86cd799439016\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Manager\",\n \"photo\": null\n },\n \"sourceUserId\": {\n \"_id\": \"507f1f77bcf86cd799439017\",\n \"firstName\": \"Alice\",\n \"lastName\": \"Creator\",\n \"photo\": null\n },\n \"CustomerPhoneNumbers\": [\n {\n \"_id\": \"507f1f77bcf86cd799439018\",\n \"phoneNumber\": \"555-123-4567\",\n \"phoneType\": \"Work\",\n \"extension\": \"123\"\n },\n {\n \"_id\": \"507f1f77bcf86cd799439019\",\n \"phoneNumber\": \"555-987-6543\",\n \"phoneType\": \"Cell\"\n }\n ],\n \"CustomerAddresses\": [\n {\n \"_id\": \"507f1f77bcf86cd79943901a\",\n \"street\": \"123 Main Street\",\n \"street1\": \"Suite 400\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"country\": \"US\",\n \"isDefault\": true\n }\n ],\n \"CustomerBillingAddress\": [\n {\n \"_id\": \"507f1f77bcf86cd79943901b\",\n \"street\": \"123 Main Street\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"country\": \"US\",\n \"isDefault\": true\n }\n ],\n \"CustomerShippers\": [\n {\n \"_id\": \"507f1f77bcf86cd79943901c\",\n \"shipperName\": \"FedEx\",\n \"accountNumber\": \"123456789\",\n \"isDefault\": true\n }\n ],\n \"CustomerNotes\": [\n {\n \"_id\": \"507f1f77bcf86cd79943901d\",\n \"note\": \"Prefers email communication\",\n \"userId\": {\n \"_id\": \"507f1f77bcf86cd799439015\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"photo\": \"https://s3.amazonaws.com/user-photo.png\"\n },\n \"createdAt\": \"2025-10-20T10:00:00.000Z\"\n }\n ],\n \"Documents\": [\n {\n \"_id\": \"507f1f77bcf86cd79943901e\",\n \"fileName\": \"contract.pdf\",\n \"title\": \"Service Contract\",\n \"url\": \"https://s3.amazonaws.com/documents/contract.pdf\",\n \"fileSize\": 245678,\n \"uploadDate\": \"2025-10-15T14:30:00.000Z\",\n \"userId\": {\n \"_id\": \"507f1f77bcf86cd799439015\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"photo\": \"https://s3.amazonaws.com/user-photo.png\"\n }\n }\n ],\n \"roles\": [\n {\n \"_id\": \"507f1f77bcf86cd79943901f\",\n \"name\": \"Customer\",\n \"settings\": {\n \"general\": [\"view_orders\", \"place_orders\"],\n \"menu\": [\"orders\", \"products\"]\n }\n }\n ],\n \"customerDevice\": {\n \"_id\": \"507f1f77bcf86cd799439020\",\n \"source\": \"CREATE_ACCOUNT\",\n \"location\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"ip\": \"192.168.1.1\"\n },\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64)...\",\n \"referrer\": \"https://google.com\"\n },\n \"utmData\": {\n \"utmSource\": \"google\",\n \"utmMedium\": \"cpc\",\n \"utmCampaign\": \"summer_2025\"\n },\n \"socialData\": [],\n \"registrationsSent\": [\n {\n \"createdAt\": \"2025-10-01T09:00:00.000Z\",\n \"storeId\": \"507f1f77bcf86cd799439013\"\n }\n ],\n \"hasFollowUps\": false,\n \"reviewsToken\": \"abc123xyz456\",\n \"referenceFields\": {},\n \"createdAt\": \"2025-10-01T09:00:00.000Z\",\n \"updatedAt\": \"2025-10-28T10:00:00.000Z\"\n}\n\n{\n \"message\": \"Customer not found\"\n}\n\n{\n \"message\": \"Customer not found!\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\nReturned when user doesn't have permission to view this customer.
\nThe endpoint applies role-based access:
\nAdmin Users: Can view all customers in the system
\nDistributor Users: Can only view customers within their distributor
\nRegular Users: Access based on role settings
\nField,Description,Data Type,Populated\n_id,Customer's unique MongoDB ID,ObjectId,No\ncustomerId,Sequential customer ID number,Number,No\nemail,Customer's email address,String,No\nfirstName,Customer's first name,String,No\nlastName,Customer's last name,String,No\njobTitle,Customer's job title,String,No\nisActive,Whether account is active,Boolean,No\nrank,Customer ranking/priority,Number,No\ncompanyId,Company object,Object,Yes\nuserId,Account Manager object,Object,Yes\nadminUserId,Sales Admin object,Object,Yes\nsourceUserId,User who created customer,Object,Yes\ndistributorId,Distributor's MongoDB ID,ObjectId,No\nstores,Array of store IDs,Array[ObjectId],No\nCustomerPhoneNumbers,Array of phone numbers,Array[Object],No\nCustomerAddresses,Array of shipping addresses,Array[Object],No\nCustomerBillingAddress,Array of billing addresses,Array[Object],No\nCustomerShippers,Array of shipper accounts,Array[Object],No\nCustomerNotes,Array of notes,Array[Object],Yes (userId)\nDocuments,Array of documents,Array[Object],Yes (full)\nroles,Array of role objects,Array[Object],Yes (full)\ncustomerDevice,Device info from creation,Object,No\nutmData,UTM tracking data,Object,No\nsocialData,Social login connections,Array[Object],No\nregistrationsSent,Registration email records,Array[Object],No\ncreatedAt,Account creation timestamp,Date,No\nupdatedAt,Last update timestamp,Date,No\n\nAuthentication Required: Must provide valid JWT Bearer token
\nValid ObjectId: customerId must be a valid 24-character hex string
\nExcluded Fields: Password fields are never returned
\nPopulated Fields: Related objects (company, users, documents, roles) are fully populated
\nNull Values: Fields may be null if not set
\nAccess Control: Response filtered based on user permissions
\nNo Query Params: This endpoint doesn't accept filtering or selection parameters
\nMethod: GET
URL: https://api.mpowerpromo.com/customers
Authentication: Required (JWT Bearer token)
GET https://api.mpowerpromo.com/customers?page=1&limit=25&ascending=1\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?query=john&page=1&limit=25\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?externalId=EXT-12345\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?customerQBId=QB-12345&populate=companyId\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?customerStripeId=cus_abc123xyz\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?customerHubspotId=12345678&page=1&limit=1\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?store=507f1f77bcf86cd799439012&orderBy=lastName&ascending=1&page=1&limit=50\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?page=1&limit=25&withLastFollowUp=1&populate=companyId,userId,stores\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?userId=507f1f77bcf86cd799439013&page=1&limit=25&ascending=1\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?isActive=true&query=&page=1&limit=25\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?onlyCount=true&isActive=true\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?exportFormat=csv&exportFields=email,firstName,lastName,companyId,externalId\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?createdAt[gte]=2025-10-01&createdAt[lte]=2025-10-31&page=1&limit=25\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?store=507f1f77bcf86cd799439012&isActive=true&userId=507f1f77bcf86cd799439013&page=1&limit=25&orderBy=lastName&ascending=1&populate=companyId\nAuthorization: Bearer {{token}}\n\nGET https://api.mpowerpromo.com/customers?customerId=12345\nAuthorization: Bearer {{token}}\n\n{\n \"data\": [\n {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"customerId\": 12345,\n \"externalId\": \"EXT-12345\",\n \"customerQBId\": \"QB-12345\",\n \"customerStripeId\": \"cus_abc123xyz\",\n \"customerHubspotId\": \"12345678\",\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"jobTitle\": \"Marketing Manager\",\n \"isActive\": true,\n \"rank\": 5,\n \"distributorId\": \"507f1f77bcf86cd799439012\",\n \"stores\": [\"507f1f77bcf86cd799439013\"],\n \"companyId\": {\n \"_id\": \"507f1f77bcf86cd799439014\",\n \"companyName\": \"Acme Corp\"\n },\n \"userId\": {\n \"_id\": \"507f1f77bcf86cd799439015\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Manager\",\n \"photo\": null\n },\n \"source\": \"Web\",\n \"createdAt\": \"2025-10-01T09:00:00.000Z\",\n \"updatedAt\": \"2025-10-28T10:00:00.000Z\"\n }\n ],\n \"count\": 150,\n \"referenceFields\": []\n}\n\n{\n \"count\": 150\n}\n\nReturns CSV file as text/plain with customer data.
\nNote: Password fields (password, passwordOrigin, passwordResetToken) are excluded from responses.
Parameter,Description,Required,Data Type,Example\npage,Page number for pagination,No,Number,page=1\nlimit,Number of records per page,No,Number,limit=25\nonlyCount,Return only count no data,No,Boolean,onlyCount=true\nascending,Sort order (1=asc 0=desc),No,Number,ascending=1\nbyColumn,Enable column sorting,No,Number,byColumn=1\norderBy,Field to sort by,No,String,orderBy=lastName\nquery,Search term,No,String,query=john\nemail,Filter by email,No,String,email=john@example.com\nfirstName,Filter by first name,No,String,firstName=John\nlastName,Filter by last name,No,String,lastName=Doe\njobTitle,Filter by job title,No,String,jobTitle=Manager\nisActive,Filter by active status,No,Boolean,isActive=true\nrank,Filter by customer rank,No,Number,rank=5\nsource,Filter by creation source,No,String,source=Web\ncompanyId,Filter by company,No,ObjectId,companyId=507f...\nstores,Filter by store,No,ObjectId,stores=507f...\nstore,Filter by store (alias),No,ObjectId,store=507f...\nuserId,Filter by account manager,No,ObjectId,userId=507f...\nadminUserId,Filter by sales admin,No,ObjectId,adminUserId=507f...\naccountManagerId,Filter by account manager,No,ObjectId,accountManagerId=507f...\nsalesAdminId,Filter by sales admin,No,ObjectId,salesAdminId=507f...\nsourceUserId,Filter by creator user,No,ObjectId,sourceUserId=507f...\ncustomerId,Filter by sequential customer ID,No,Number,customerId=12345\nexternalId,Filter by external/third-party ID,No,String,externalId=EXT-12345\ncustomerQBId,Filter by QuickBooks ID,No,String,customerQBId=QB-12345\ncustomerZohoId,Filter by Zoho CRM ID,No,String,customerZohoId=ZOHO-12345\ncustomerHubspotId,Filter by HubSpot ID,No,String,customerHubspotId=HS-12345\ncustomerXeroId,Filter by Xero accounting ID,No,String,customerXeroId=XERO-12345\ncustomerStripeId,Filter by Stripe customer ID,No,String,customerStripeId=cus_12345\npopulate,Fields to populate,No,String,populate=companyId,userId\nexportFormat,Export format,No,String,exportFormat=csv\nexportFields,Fields to export,No,String,exportFields=email,firstName\nwithLastFollowUp,Include follow-up info,No,Number,withLastFollowUp=1\nhasFollowUps,Filter by follow-up status,No,Boolean,hasFollowUps=true\nnoDistributor,Disable distributor filter,No,Boolean,noDistributor=true\nloadByAccountManager,Load by account manager context,No,Boolean,loadByAccountManager=true\nforceQueryByName,Force search by name,No,Boolean,forceQueryByName=true\ndefaultValue,Include specific customer,No,ObjectId,defaultValue=507f...\ncreatedAt,Filter by creation date,No,Date/Object,createdAt[gte]=2025-01-01\nupdatedAt,Filter by update date,No,Date/Object,updatedAt[lte]=2025-12-31\nlastContactedAt,Filter by last contact date,No,Date/Object,lastContactedAt[gte]=2025-10-01\n\nAuto-filtering by Distributor: Results automatically filtered by logged-in user's distributor (unless admin with noDistributor=true)
Deleted Records: Automatically excluded (deletedAt: { $exists: false })
\nRole-based Access:
\nAdmin roles can view all distributor customers
\nRegular users see customers based on role settings
\nPopulate: Only populated if explicitly requested via populate parameter
Search Query: Searches across multiple fields (email, firstName, lastName, etc.)
\nExternal IDs: All external ID filters perform exact matches
\n/customers?page=1&limit=25&ascending=1&orderBy=lastName\n\n/customers?query=john&page=1&limit=25\n\n/customers?externalId=EXT-12345\n/customers?customerQBId=QB-12345\n/customers?customerStripeId=cus_12345\n\n/customers?store=507f1f77bcf86cd799439012&page=1&limit=25\n\n/customers?onlyCount=true&isActive=true\n\n/customers?exportFormat=csv&exportFields=email,firstName,lastName,companyId,externalId\n\n/customers?page=1&limit=25&populate=companyId,userId,stores&withLastFollowUp=1\n\nRequired Parameters: None - all parameters are optional
\nEmpty Query String: query=\"\" is valid and returns all customers
Multiple Filters: Can combine multiple filter parameters
\nDate Filtering: Use MongoDB query operators like [gte], [lte], [gt], [lt]
Populate Performance: Only populate fields you need to reduce response size
\nExport: When exporting, pagination is ignored and all matching records are returned
\nAuthentication: Valid JWT Bearer token required in all cases
\nExternal IDs: All external ID fields are case-sensitive and perform exact matches
\nCase Sensitivity: Most string filters are case-sensitive unless using query parameter
Required Fields: Only email and stores are strictly required
Auto-Generated: Fields like customerId, createdBy, sourceUserId, and distributorId are auto-set if not provided
Conditional Required: CustomerBillingAddress[].country is required IF you're adding billing addresses
ObjectId Format: Use valid MongoDB ObjectId strings (24 hex characters)
\nDate Format: Use ISO 8601 format (e.g., \"2025-10-28T10:00:00.000Z\")
\nCountry Codes: Use ISO 2-letter codes (US, CA, GB, etc.)
\nPhone Types: Common values are \"Work\", \"Cell\", \"Home\", \"Fax\"
\nMethod: PUT or PATCH
URL: https://api.mpowerpromo.com/customers/{{customerId}}
Authentication: Required (JWT Bearer token)
Note: Both PUT and PATCH methods are supported and use the same handler.
Important: password field is automatically removed from updates for security. Use passwordOrigin to update password.
{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"phoneNumber\": \"555-123-4567\",\n \"phoneType\": \"Work\",\n \"extension\": \"123\"\n}\n\n{\n \"_id\": \"507f1f77bcf86cd799439012\",\n \"street\": \"123 Main Street\",\n \"street1\": \"Suite 400\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"country\": \"US\",\n \"isDefault\": true\n}\n\n{\n \"_id\": \"507f1f77bcf86cd799439013\",\n \"street\": \"123 Main Street\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10001\",\n \"country\": \"US\",\n \"isDefault\": true\n}\n\n{\n \"_id\": \"507f1f77bcf86cd799439014\",\n \"shipperName\": \"FedEx\",\n \"accountNumber\": \"123456789\",\n \"isDefault\": true\n}\n\n{\n \"_id\": \"507f1f77bcf86cd799439015\",\n \"note\": \"Important customer note\",\n \"userId\": \"507f1f77bcf86cd799439016\",\n \"createdAt\": \"2025-10-28T10:00:00.000Z\"\n}\n\nThese fields are automatically managed and cannot be directly updated:
\n❌ password - Removed for security (use passwordOrigin)
❌ __v - Mongoose version key
✅ customerId - Auto-generated if missing
✅ updatedAt - Auto-updated on save
PUT https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe.updated@example.com\",\n \"jobTitle\": \"Senior Marketing Manager\"\n}\n\nPUT https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"externalId\": \"EXT-12345\",\n \"customerQBId\": \"QB-98765\",\n \"customerStripeId\": \"cus_abc123xyz\",\n \"customerHubspotId\": \"12345678\"\n}\n\nPUT https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"passwordOrigin\": \"NewSecurePassword123!\"\n}\n\nPUT https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"userId\": \"507f1f77bcf86cd799439016\",\n \"adminUserId\": \"507f1f77bcf86cd799439017\",\n \"isActive\": true,\n \"rank\": 5\n}\n\nPUT https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"customerCompany\": \"Acme Corporation Updated\",\n \"jobTitle\": \"VP of Marketing\"\n}\n\nPUT https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"stores\": [\n \"507f1f77bcf86cd799439020\",\n \"507f1f77bcf86cd799439021\"\n ]\n}\n\nPUT https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"CustomerPhoneNumbers\": [\n {\n \"phoneNumber\": \"555-123-4567\",\n \"phoneType\": \"Work\",\n \"extension\": \"123\"\n },\n {\n \"phoneNumber\": \"555-987-6543\",\n \"phoneType\": \"Cell\"\n }\n ]\n}\n\nPUT https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"CustomerAddresses\": [\n {\n \"street\": \"456 Oak Avenue\",\n \"street1\": \"Building B\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"zip\": \"90001\",\n \"country\": \"US\",\n \"isDefault\": true\n }\n ]\n}\n\nPUT https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"CustomerBillingAddress\": [\n {\n \"street\": \"789 Billing Street\",\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"zip\": \"60601\",\n \"country\": \"US\",\n \"isDefault\": true\n }\n ]\n}\n\nPUT https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: Bearer {{token}}\nContent-Type: application/json\n{\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"email\": \"jane.smith@example.com\",\n \"jobTitle\": \"Director of Operations\",\n \"externalId\": \"EXT-UPDATED-001\",\n \"customerStripeId\": \"cus_newstripe123\",\n \"isActive\": true,\n \"rank\": 10,\n \"userId\": \"507f1f77bcf86cd799439016\",\n \"stores\": [\n \"507f1f77bcf86cd799439020\"\n ],\n \"CustomerPhoneNumbers\": [\n {\n \"phoneNumber\": \"555-111-2222\",\n \"phoneType\": \"Work\"\n }\n ],\n \"referenceFields\": {\n \"customField1\": \"Updated Value\",\n \"customField2\": \"New Value\"\n }\n}\n\n{\n \"$$notification\": {\n \"success\": \"Successfully Saved\"\n },\n \"model\": {\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"customerId\": 12345,\n \"email\": \"john.doe.updated@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"jobTitle\": \"Senior Marketing Manager\",\n \"externalId\": \"EXT-12345\",\n \"customerQBId\": \"QB-98765\",\n \"customerStripeId\": \"cus_abc123xyz\",\n \"customerHubspotId\": \"12345678\",\n \"isActive\": true,\n \"rank\": 5,\n \"distributorId\": \"507f1f77bcf86cd799439012\",\n \"stores\": [\"507f1f77bcf86cd799439020\"],\n \"userId\": \"507f1f77bcf86cd799439016\",\n \"adminUserId\": \"507f1f77bcf86cd799439017\",\n \"CustomerPhoneNumbers\": [\n {\n \"_id\": \"507f1f77bcf86cd799439018\",\n \"phoneNumber\": \"555-123-4567\",\n \"phoneType\": \"Work\",\n \"extension\": \"123\"\n }\n ],\n \"CustomerAddresses\": [\n {\n \"_id\": \"507f1f77bcf86cd79943901a\",\n \"street\": \"456 Oak Avenue\",\n \"city\": \"Los Angeles\",\n \"state\": \"CA\",\n \"zip\": \"90001\",\n \"country\": \"US\"\n }\n ],\n \"createdAt\": \"2025-10-01T09:00:00.000Z\",\n \"updatedAt\": \"2025-10-28T10:30:00.000Z\"\n }\n}\n\n{\n \"$$notification\": {\n \"error\": \"Email already in use\"\n }\n}\n\n{\n \"$$notification\": {\n \"error\": \"Validation error message\"\n }\n}\n\n{\n \"error\": \"User is not available\"\n}\n\n{\n \"message\": \"Customer not found\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\nValidates email is unique across the distributor
\nExcludes the current customer from uniqueness check
\nCase-insensitive check
\nIf customerCompany is provided, updates the linked company's name
Uses the existing companyId to find and update the company
password field is automatically removed from request body
passwordOrigin is extracted and handled separately
Password is encrypted automatically before saving
\nIf both CustomerAddresses and CustomerBillingAddress are provided
State fields are automatically filled/validated
\nIf stores array is updated, duplicates are automatically removed
Uses clearStoresDuplicates() helper
stores are updated, customer is automatically synced to SendGridcustomerId from sequenceAll changes are logged to the Log collection
Tracks before/after state with detailed diff
\nIncludes IP, user, and timestamp
\nAutomatically clears all cache keys after update
\nClears runtime cache
\nAutomatically removes private/sensitive fields via removePrivateData()
Based on user permissions and context
\npassword - Use passwordOrigin instead (auto-encrypted)
__v - Mongoose version key (auto-managed)
\ndeletedAt - Use DELETE endpoint instead
\ncustomerId - Auto-generated sequential ID if missing
\nupdatedAt - Auto-updated timestamp
\ncreatedBy - Cannot be changed after creation
\nEmail - Must be valid email format and unique per distributor
\nCustomerBillingAddress - Entries without country are filtered out
Stores - Duplicates automatically removed
\nObjectId Fields - Must be valid MongoDB ObjectIds
\nSendGrid - Customer synced to SendGrid if stores updated
\nHubSpot - Customer synced to HubSpot after save
\nCache - All caches cleared after update
\nLogging - Changes tracked in Log collection with full diff
\nCompany - Company name updated if customerCompany provided
Field,Description,Required,Data Type,Updatable,Notes\nemail,Customer email address,No,String,Yes,Must be unique per distributor\nfirstName,First name,No,String,Yes,-\nlastName,Last name,No,String,Yes,-\njobTitle,Job title,No,String,Yes,-\nisActive,Active status,No,Boolean,Yes,-\nrank,Customer rank,No,Number,Yes,-\ncustomerCompany,Company name,No,String,Yes,Updates linked company record\ncompanyId,Company reference,No,ObjectId,Yes,-\npasswordOrigin,Plain text password,No,String,Yes,Auto-encrypted\nuserId,Account Manager,No,ObjectId,Yes,-\nadminUserId,Sales Admin,No,ObjectId,Yes,-\nsourceUserId,Creator user,No,ObjectId,Yes,-\nstores,Store IDs array,No,Array[ObjectId],Yes,Auto-deduped\ndistributorId,Distributor ID,No,ObjectId,Yes,-\nsupplierId,Supplier ID,No,ObjectId,Yes,-\nsource,Creation source,No,String,Yes,-\nexternalId,External/third-party ID,No,String,Yes,-\ncustomerQBId,QuickBooks ID,No,String,Yes,-\ncustomerZohoId,Zoho CRM ID,No,String,Yes,-\ncustomerHubspotId,HubSpot ID,No,String,Yes,-\ncustomerXeroId,Xero ID,No,String,Yes,-\ncustomerStripeId,Stripe ID,No,String,Yes,-\nCustomerPhoneNumbers,Phone array,No,Array[Object],Yes,Replaces entire array\nCustomerAddresses,Address array,No,Array[Object],Yes,Replaces entire array\nCustomerBillingAddress,Billing address array,No,Array[Object],Yes,Replaces entire array\nCustomerShippers,Shipper array,No,Array[Object],Yes,Replaces entire array\nCustomerNotes,Notes array,No,Array[Object],Yes,Replaces entire array\nDocuments,Document IDs,No,Array[ObjectId],Yes,-\nroles,Role IDs,No,Array[ObjectId],Yes,-\nsocialData,Social login data,No,Array[Object],Yes,-\nreferenceFields,Custom fields,No,Object,Yes,-\nhasFollowUps,Has follow-ups flag,No,Boolean,Yes,-\nlastContactedAt,Last contact date,No,Date,Yes,ISO 8601 format\npassword,Password (encrypted),No,String,No,Use passwordOrigin instead\ncustomerId,Sequential customer ID,No,Number,No,Auto-generated if missing\n__v,Version key,No,Number,No,Auto-managed by Mongoose\n\nPartial Updates: Only send fields you want to update
\nEmail Changes: Verify email uniqueness before updating
\nPassword Updates: Always use passwordOrigin, never password
Array Fields: When updating arrays, send the complete array (not individual items)
\nExternal IDs: Use appropriate external ID fields for integrations
\nValidation: Check for validation errors in response
\nLogging: All changes are logged - ensure user has proper context
\nCache: Updates clear cache - may affect performance in high-volume scenarios
\nMethod: DELETE
URL: https://api.mpowerpromo.com/customers/{{customerId}}
Authentication: Required (JWT Bearer token)
Important: This is a soft delete - the customer record is not permanently removed from the database. Instead, a deletedAt timestamp is set, marking the customer as deleted.
None - This endpoint does not require a request body.
\nNone - This endpoint does not accept query parameters.
\nDELETE https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: Bearer {{token}}\n\nMethod: DELETE
URL: https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011
Headers:
Authorization: Bearer {{token}}\n\nBody: None
\nReturns the deleted customer object with the deletedAt field set:
{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"customerId\": 12345,\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"jobTitle\": \"Marketing Manager\",\n \"externalId\": \"EXT-12345\",\n \"customerQBId\": \"QB-98765\",\n \"customerStripeId\": \"cus_abc123xyz\",\n \"isActive\": true,\n \"distributorId\": \"507f1f77bcf86cd799439012\",\n \"stores\": [\"507f1f77bcf86cd799439013\"],\n \"companyId\": \"507f1f77bcf86cd799439014\",\n \"userId\": \"507f1f77bcf86cd799439015\",\n \"CustomerPhoneNumbers\": [],\n \"CustomerAddresses\": [],\n \"createdAt\": \"2025-10-01T09:00:00.000Z\",\n \"updatedAt\": \"2025-10-28T10:00:00.000Z\",\n \"deletedAt\": \"2025-10-28T15:30:00.000Z\"\n}\n\n{\n \"message\": \"Customer not found\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\n{\n \"message\": \"Access denied\"\n}\n\nSoft Delete
\nCustomer record is NOT permanently removed
\ndeletedAt field is set to current timestamp
Customer remains in database but is marked as deleted
\nAPI Token Logging
\nDelete action is logged via logCustomerApiTokenRequest()
Tracks which user/token performed the deletion
\nIncludes timestamp and customer information
\nCustomer Visibility
\nDeleted customers are automatically excluded from GET /customers list queries
Filter applied: deletedAt: { $exists: false }
Can still be retrieved by direct ID if needed (for audit/recovery)
\nRelated Data
\nCustomer's orders, artwork, documents remain intact
\nRelationships preserved for historical/audit purposes
\nNo cascade deletion of related records
\n✅ What This Endpoint Does (Soft Delete):
\nSets deletedAt timestamp
Hides customer from normal queries
\nPreserves all data for audit/recovery
\nMaintains referential integrity
\n❌ What This Endpoint Does NOT Do (Hard Delete):
\nDoes not permanently remove the record
\nDoes not delete related orders
\nDoes not delete customer artwork
\nDoes not remove from database
\nTo restore a soft-deleted customer, you would need to:
\nUse a direct database update to remove the deletedAt field
Or use a custom restore endpoint if available
\nUser must have appropriate permissions to delete customers
\nTypically restricted to admin users or account managers
\nDeletion is logged for audit trail
\nImportant for integrations:
\nExternal IDs (externalId, customerQBId, customerStripeId, etc.) remain in the database
If re-creating a customer with the same external ID, you may encounter conflicts
\nConsider checking for soft-deleted customers before creating new ones
\nDeleted customers can still be queried directly by ID:
\nGET https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: Bearer {{token}}\n\nResponse will include:
\n{\n \"_id\": \"507f1f77bcf86cd799439011\",\n \"deletedAt\": \"2025-10-28T15:30:00.000Z\",\n ...\n}\n\nDeleted customers are automatically excluded:
\nGET https://api.mpowerpromo.com/customers?email=john.doe@example.com\nAuthorization: Bearer {{token}}\n\nResponse:
\n{\n \"data\": [],\n \"count\": 0\n}\n\nDELETE https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439011\nAuthorization: Bearer {{token}}\n\nDELETE https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439012\nAuthorization: Bearer {{token}}\n\nDELETE https://api.mpowerpromo.com/customers/507f1f77bcf86cd799439013\nAuthorization: Bearer {{token}}\n\nNote: For full GDPR compliance, you may need additional steps to anonymize or permanently delete data.
\nPOST https://api.mpowerpromo.com/customers\n\nPUT https://api.mpowerpromo.com/customers/{{customerId}}\n\nGET https://api.mpowerpromo.com/customers/{{customerId}}\n\nGET https://api.mpowerpromo.com/customers?page=1&limit=25\n\nField,Value\nMethod,DELETE\nEndpoint,/customers/:customerId\nAuthentication,Required (JWT Bearer)\nRequest Body,None\nQuery Parameters,None\nDelete Type,Soft Delete\nSets Field,deletedAt\nReturns,Customer object with deletedAt timestamp\nRemoves Data,No - soft delete only\nCascade Delete,No\nLogged,Yes - via logCustomerApiTokenRequest\nReversible,Yes - requires database update\nSuccess Code,200\nError Codes,\"404 (Not Found), 401 (Unauthorized), 403 (Forbidden)\"\n\nConfirm Before Delete: Always confirm user intent before deleting
\nCheck Dependencies: Review customer's orders/data before deletion
\nAudit Trail: Deletion is logged - ensure proper user context
\nExternal Systems: Notify integrated systems (QuickBooks, Stripe, etc.) about deletion
\nRecovery Plan: Have a process to restore accidentally deleted customers
\nGDPR Compliance: If permanent deletion needed for compliance, additional steps required
\nBatch Operations: For bulk deletions, consider creating a batch endpoint
\nGet company by his id
\n","urlObject":{"path":["companies","{{companyId}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b884bb8c-3f31-4afe-a9ef-311972e47e37"},{"name":"Get Customers","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"companyId\", jsonData.data[0]._id); "],"type":"text/javascript","packages":{}}}],"id":"bd464828-71a4-4c9f-83f7-991084d593c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/companies/all?page=1&query=\"\"&limit&25&ascending=1&page=1&byColumn=1&orderBy=companyName&withLastFollowUp=1","description":"Get companies
\n","urlObject":{"path":["companies","all"],"host":["https://api.mpowerpromo.com"],"query":[{"key":"page","value":"1"},{"key":"query","value":"\"\""},{"key":"limit","value":""},{"key":"25","value":""},{"key":"ascending","value":"1"},{"key":"page","value":"1"},{"key":"byColumn","value":"1"},{"key":"orderBy","value":"companyName"},{"key":"withLastFollowUp","value":"1"}],"variable":[]}},"response":[],"_postman_id":"bd464828-71a4-4c9f-83f7-991084d593c7"},{"name":"Create Company","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"companyId\", jsonData._id); "],"type":"text/javascript","packages":{}}}],"id":"3b9ac4fb-00b1-4aab-bfc6-e45b34c8158f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"{ \n \"companyName\": \"New company\" \n}","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/companies","description":"Create new company
\n","urlObject":{"path":["companies"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3b9ac4fb-00b1-4aab-bfc6-e45b34c8158f"},{"name":"Edit Company","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":[""],"type":"text/javascript","packages":{}}}],"id":"a0881cca-72ec-48da-9aab-5f469339f819","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"{\n \"companyName\": \"New company2\" \n}","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/companies/{{companyId}}","description":"Edit company. Can update all fields
\n","urlObject":{"path":["companies","{{companyId}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a0881cca-72ec-48da-9aab-5f469339f819"},{"name":"Delete Company","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":[""],"type":"text/javascript","packages":{}}}],"id":"23cb966a-52c7-4ce8-95d5-60d08fe9622d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/companies/{{companyId}}","description":"Delete the company
\n","urlObject":{"path":["companies","{{companyId}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"23cb966a-52c7-4ce8-95d5-60d08fe9622d"}],"id":"efe2509c-8683-4ea6-a408-fd76d64bdfa5","_postman_id":"efe2509c-8683-4ea6-a408-fd76d64bdfa5","description":""},{"name":"Shipping","item":[{"name":"Add Tracking","id":"40eaee24-f5ab-475b-9528-8277cb82121b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{apiToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trackingNumber\": \"1ZRA05870382170881\",\n \"carrier\": \"ups\",\n \"shipmentId\": \"59717\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/orders/{{orderId}}/trackings","description":"This endpoint allows users to track the shipment of a specific order by providing tracking information. By sending a POST request to the /orders/{{orderId}}/trackings endpoint, users can update or add tracking details associated with their order.
The request body must be in JSON format and should include the following parameters:
\ntrackingNumber (string): The unique identifier assigned to the shipment by the carrier. This is essential for tracking the package's status.
\ncarrier (string): The name of the shipping carrier responsible for delivering the package (e.g., UPS, FedEx). (optional)
\nshipmentId (string): The identifier for the shipment, which may be used internally to track the shipment's progress. (optional)
\n{\n \"trackingNumber\": \"1ZRA05870382170881\",\n \"carrier\": \"ups\",\n \"shipmentId\": \"59717\"\n}\n\nUpon successful processing of the request, the API will return a response indicating the status of the tracking update. The response typically includes confirmation of the tracking information added or updated, along with any relevant metadata about the order and tracking status.
\nEnsure that all required parameters are included in the request to avoid errors and ensure proper tracking of the shipment.
\n","urlObject":{"path":["orders","{{orderId}}","trackings"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"40eaee24-f5ab-475b-9528-8277cb82121b"}],"id":"bac522fe-ed59-4309-826a-4ba5837882ee","_postman_id":"bac522fe-ed59-4309-826a-4ba5837882ee","description":""},{"name":"Stores","item":[{"name":"Get Stores","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"storeId\", jsonData.data[0]._id); "],"type":"text/javascript","packages":{}}}],"id":"ec14a1b6-d88e-4713-95a3-ff7459870c39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/stores?query=\"\"&limit=25=ascending=1&page=1&byColumn=0&orderBy=\"storeName\"&project=[\"storeName\",\"storeUrl\",\"isTemplate\"]","description":"Get product
\n","urlObject":{"path":["stores"],"host":["https://api.mpowerpromo.com"],"query":[{"key":"query","value":"\"\""},{"key":"limit","value":"25=ascending=1"},{"key":"page","value":"1"},{"key":"byColumn","value":"0"},{"key":"orderBy","value":"\"storeName\""},{"key":"project","value":"[\"storeName\",\"storeUrl\",\"isTemplate\"]"}],"variable":[]}},"response":[],"_postman_id":"ec14a1b6-d88e-4713-95a3-ff7459870c39"},{"name":"Create Store","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"storeId\", jsonData.model._id); "],"type":"text/javascript","packages":{}}}],"id":"9d6cd39c-c890-4be3-baf2-60c1cae78073","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"{\n \"countries\": [],\n \"HeadTags\": [\n {\n \"headTag\": {\n \"isBootstrap\": true,\n \"tagType\": \"link\",\n \"description\": \"Bootstrap Theme\",\n \"rel\": \"stylesheet\",\n \"href\": \"https://cdn.jsdelivr.net/npm/bootstrap@4.6.2/dist/css/bootstrap.min.css\"\n },\n \"tagType\": \"link\"\n }\n ],\n \"isActive\": true,\n \"phone\": {\n \"phoneNumber\": \"111-111-1111\",\n \"countryCode\": \"1\",\n \"extension\": null,\n \"phoneType\": null\n },\n \"storeName\": \"tempcooolstore\",\n \"logoUrl\": \"\",\n \"redirectURLs\": [], \n \"storeUrl\": \"tempcooolstore.mpowerpromo.com\" \n}","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/stores","description":"Create store
\n","urlObject":{"path":["stores"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d6cd39c-c890-4be3-baf2-60c1cae78073"},{"name":"Sync with Brand SSL","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":["var jsonData = JSON.parse(responseBody);\r","postman.setEnvironmentVariable(\"storeId\", jsonData.model._id); "],"type":"text/javascript","packages":{}}}],"id":"4566631d-15e3-4e30-abc8-71f843217aef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"{\"domain\":\"gopromonow.com\"}","options":{"raw":{"language":"json"}}},"url":"https://www.brandssl.io/api/7400901801088198/tls","description":"Create store
\n","urlObject":{"protocol":"https","path":["api","7400901801088198","tls"],"host":["www","brandssl","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"4566631d-15e3-4e30-abc8-71f843217aef"},{"name":"Edit Store","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":[""],"type":"text/javascript","packages":{}}}],"id":"a56484ef-c816-43fb-9e83-d808e22ccdfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"{\n \"_id\":\"63a5e6f3f04e641d0276d9c6\",\n \"data\":{\n \"storeName\":\"temp new name\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/stores","description":"Edit store
\n","urlObject":{"path":["stores"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a56484ef-c816-43fb-9e83-d808e22ccdfb"},{"name":"Delete Store","event":[{"listen":"test","script":{"id":"18e5c3a2-8c23-49a0-94ad-e5b69bfde53d","exec":[""],"type":"text/javascript","packages":{}}}],"id":"c0a14959-14e5-4ab9-b81b-bd1dad3c302d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"authorization","value":"{{apiToken}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.mpowerpromo.com/stores/{{storeId}}","description":"Get product
\n","urlObject":{"path":["stores","{{storeId}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c0a14959-14e5-4ab9-b81b-bd1dad3c302d"},{"name":"New Request","id":"f35dcfde-6c7f-452c-b2ed-cadc7eae34d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"f35dcfde-6c7f-452c-b2ed-cadc7eae34d2"}],"id":"93e3d0ba-5ff2-4ba5-a48b-762213d5d9be","_postman_id":"93e3d0ba-5ff2-4ba5-a48b-762213d5d9be","description":""},{"name":"PromoStandards","item":[{"name":"getProductData","id":"fd685b54-7dcb-42de-b796-91ce69dac8d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"SOAPaction","value":"getProduct"}],"body":{"mode":"raw","raw":"\r\nFunction: getProduct()
\nThis function will provide the detail product data based on a specific ProductId or any additional optional subset filtering provided at the request
\nRequest url params
\nResponse
\n","urlObject":{"path":["ps","{{supplierCode}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fd685b54-7dcb-42de-b796-91ce69dac8d8"},{"name":"getProductsSellable","id":"e9f1a9d4-b9f8-4b43-acce-1dbf711bd372","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"SOAPaction","value":"getProductSellable"}],"body":{"mode":"raw","raw":"\r\ngetProductSellable()
\nThis function will provide a list of Product Ids and optional Part Ids along with their status of available to sell (Sellable TRUE or FALSE).
\nRequest url params
\nRequest body params
\nResponse
\n","urlObject":{"path":["ps","{{supplierCode}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9f1a9d4-b9f8-4b43-acce-1dbf711bd372"},{"name":"getFobPoints","id":"89014a59-9616-4897-bd27-3aac83d32292","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"SOAPaction","value":"getFobPoints"}],"body":{"mode":"raw","raw":"\r\nFunction: getFobPoints()
\nThis function will return basic information about FOB points for a given product.
\nRequest url params
\nRequest body params
\nResponse
\n","urlObject":{"path":["ps","{{supplierCode}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"89014a59-9616-4897-bd27-3aac83d32292"},{"name":"getConfigurationAndPricing","id":"8a4bb456-325b-4e97-a09a-67416f3738dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"SOAPaction","value":"getConfigurationAndPricing"}],"body":{"mode":"raw","raw":"\r\nFunction: GetConfigurationAndPricing()
\nThis function will provide the pricing and configuration of a product.
\nRequest body params
\nResponse
\n","urlObject":{"path":["ps","{{supplierCode}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a4bb456-325b-4e97-a09a-67416f3738dd"},{"name":"getMedia","id":"f5497ab3-3879-4ab3-a484-a099170a1e90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"},{"key":"SOAPaction","value":"getMediaContent"}],"body":{"mode":"raw","raw":"\r\nFunction: getMediaContent()
\nSummary: Provides a mechanism to get a media content by specific parameters like (last change date, product id, part id, media type, etc). This allows the consumer of the service to obtain specific media content for their needs.
\nRequest url params
\nResponse
\n","urlObject":{"path":["ps","{{supplierCode}}"],"host":["https://api.mpowerpromo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f5497ab3-3879-4ab3-a484-a099170a1e90"}],"id":"bd2bd61c-8995-4466-bf55-1e2c7df2ee10","_postman_id":"bd2bd61c-8995-4466-bf55-1e2c7df2ee10","description":""}],"event":[{"listen":"prerequest","script":{"id":"6055f646-27b0-4596-82cb-38e2a5a0ea14","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6ade3a44-0c55-4980-b586-9795411a8857","type":"text/javascript","exec":[""]}}],"variable":[{"id":"ecc6b3be-ec7f-48f2-8921-193b98cf88cc","key":"host","value":"https://api.mpowerpromo.com"}]}