FlexOps Core Services API

Complete logistics and fulfillment API for managing inventory, orders, returns, shipping, and serial tracking. Full OpenAPI 3.0 specification with 129 endpoints across 18 resource groups.

Base URL & authentication

All requests are made over HTTPS. Use your secret API key as a bearer token.

base-auth.http

Base URL:
  https://localhost:7190

Authentication:
  Authorization: Bearer YOUR_API_KEY

Quick start – create a shipment

create-shipment.http

POST /api/v3/AddressValidation/postFedExValidatePostalCode
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
  /* Request body */
}

The response returns a purchased label, tracking number, and shipment status.

Core resources

AddressValidation

GET/api/v3/AddressValidation/getUspsCityStateLookupByZipCode
City state lookup by zip code via usps api as an asynchronous operation.
GET/api/v3/AddressValidation/getUspsValidateAndCorrectAddress
Validates and corrects a domestic address via usps api as an asynchronous operation.
GET/api/v3/AddressValidation/getUspsZipCodeLookupByAddress
Zip code lookup by address via an usps api as an asynchronous operation.
POST/api/v3/AddressValidation/postFedExValidateAndCorrectDomesticAddress
Validate and correct an address using the FedEx api as an asynchronous operation.
POST/api/v3/AddressValidation/postFedExValidatePostalCode
Validate a postal code using the FedEx api as an asynchronous operation.

Analytics

GET/api/v4/Analytics/CarrierPerformance
No description available
GET/api/v4/Analytics/CarrierSummary
No description available
GET/api/v4/Analytics/CustomerAcquisitionTrend
No description available
GET/api/v4/Analytics/CustomerMetrics
No description available
GET/api/v4/Analytics/FulfillmentTrend
No description available
GET/api/v4/Analytics/InventoryMetrics
No description available
GET/api/v4/Analytics/OrderMetrics
No description available
GET/api/v4/Analytics/OrderTrend
No description available
GET/api/v4/Analytics/PerformanceMetrics
No description available
GET/api/v4/Analytics/ReturnReasons
No description available
GET/api/v4/Analytics/ReturnsMetrics
No description available
GET/api/v4/Analytics/ReturnsTrend
No description available
GET/api/v4/Analytics/ShipmentsTrend
No description available
GET/api/v4/Analytics/TopCustomers
No description available
GET/api/v4/Analytics/TopDestinations
No description available
GET/api/v4/Analytics/TopSellingProducts
No description available

CarrierPickup

GET/api/v3/CarrierPickup/getUspsCarrierPickupSchedule
Get usps carrier pickup schedule as an asynchronous operation.
GET/api/v3/CarrierPickup/getUspsCheckCarrierPickupAddressEligibility
Check usps carrier pickup address eligibility as an asynchronous operation.
POST/api/v3/CarrierPickup/postFedExCheckCarrierPickupAddressEligibility
Check FedEx carrier pickup availability as an asynchronous operation.
POST/api/v3/CarrierPickup/postFedExCreateCarrierPickupRequest
Create a new FedEx carrier pickup request.
POST/api/v3/CarrierPickup/postUspsCreateCarrierPickupSchedule
Create usps carrier pickup schedule as an asynchronous operation.
PUT/api/v3/CarrierPickup/putFedExCancelCarrierPickupRequest
Cancel a FedEx carrier pickup request.
PUT/api/v3/CarrierPickup/putUpdateCarrierPickupSchedule
Update usps carrier pickup schedule as an asynchronous operation.
DELETE/api/v3/CarrierPickup/cancelUspsCarrierPickupSchedule
Cancel usps carrier pickup schedule as an asynchronous operation.

Files

GET/api/v2/Files/downloadFile
Downloads a file asynchronously

Inventory

GET/api/v1/Inventory/getCompleteInventorySnapshot
Gets the complete inventory snapshot (all warehouse locations).
GET/api/v1/Inventory/getPartNumberList
Gets the part number list.
GET/api/v1/Inventory/getWarehouseInventorySnapshot
Gets the warehouse inventory snapshot.
POST/api/v1/Inventory/postNewAsnReceipt
Submits the new ship asn receipt.
POST/api/v2/Inventory/postCustomerInventoryUpdate
Posts the inventory update.

LocationSearch

GET/api/v3/LocationSearch/getUspsFindValidDropOffLocations
Get valid usps drop-off location as an asynchronous operation.
GET/api/v3/LocationSearch/getUspsFindValidPostOfficeLocations
Get valid usps post office location as an asynchronous operation.
POST/api/v3/LocationSearch/postFedExSearchValidLocations
Search FedEx locations as an asynchronous operation.

Observability

GET/api/v4/Observability/status
Gets the status.

Order

GET/api/v1/Order/getActiveWarehouseList
Gets the active customer warehouse list.
GET/api/v1/Order/getAllOrderItemsByOrderNumber
Gets all order items by order number.
GET/api/v1/Order/getAllOrderItemsListByStatus
Gets all order items list by status.
GET/api/v1/Order/getAllOrderListByStatus
Gets all order list by status.
GET/api/v1/Order/getAvailableShipMethodsList
Gets the ship methods list.
GET/api/v1/Order/getCanceledOrderList
Gets the canceled orders list.
GET/api/v1/Order/getCarrierShipRateCardDetailByCarrierId
Gets the carrier ship rate card detail using carrier identifier, rate type, rate master class, package physical dimension measurements in inches, and weight measurement in ounces.
GET/api/v1/Order/getCarrierShipRateCardValuesByCarrierId
Gets the carrier ship rate card using carrier identifier, rate type, master class and rate subclass
GET/api/v1/Order/getCompleteOrderDetailsByOrderNumber
Gets the complete order details by order number.
GET/api/v1/Order/getCountryNameCodeList
Gets the country name / code list.
GET/api/v1/Order/getCountryStateProvinceCodeList
Gets the country state / province code list.
GET/api/v1/Order/getCustomerNameById
Gets the name of the customer.
GET/api/v1/Order/getDutyTaxTypesList
Gets the duty tax types list.
GET/api/v1/Order/getExtendedOrderDetailsByOrderNumber
Gets the extended order details by order number.
GET/api/v1/Order/getFreightTermTypesList
Gets the freight term types list.
GET/api/v1/Order/getIndividualOrderStatusByOrderNumber
Gets the individual order status by order number.
GET/api/v1/Order/getNewOrderItemsList
Gets the new order items list.
GET/api/v1/Order/getNewOrderList
Gets the new order list.
GET/api/v1/Order/getOrderAddressByOrderNumberAndAddressTypeId
Gets the order address by order number and address type identifier.
GET/api/v1/Order/getOrderAddressTypesList
Gets the order address types list.
GET/api/v1/Order/getOrderAmountTypesList
Gets the order amount types list.
GET/api/v1/Order/getOrderSignatureDeliveryTypesList
Gets the order signature delivery types list.
GET/api/v1/Order/getOrderStatusCategoryTypesList
Gets the order status category types list.
GET/api/v1/Order/getOrderStatusTypesList
Gets the order status types list.
GET/api/v1/Order/getShipMethodByCarrierProvidedParcel
Retrieve ship method by carrier provided parcel as an asynchronous operation.
GET/api/v1/Order/getZoneSpecificCarrierShipRateCardDetailByCarrierId
Gets the zone specific carrier ship rate card detail using carrier identifier, rate type, master class, dimensions, weight and zone.
POST/api/v1/Order/cancelOrderByOrderNumber
Cancels an order using the order number.
POST/api/v1/Order/insertUpdateOrderAddressUsingOrderNumberAndTypeId
Insert update order address using order number and type identifier as an asynchronous operation.
POST/api/v1/Order/postNewOrder
Posts a new order.

RateCalculator

POST/api/v3/RateCalculator/postRetrieveFedExRateAndTransitTimesAsync
Get FedEx rate and transit times as an asynchronous operation.
POST/api/v3/RateCalculator/postUspsSearchDomesticBaseRates
Get USPS domestic base rates as an asynchronous operation.
POST/api/v3/RateCalculator/postUspsSearchEligibleDomesticExtraServices
Get eligible usps domestic extra services as an asynchronous operation.
POST/api/v3/RateCalculator/postUspsSearchEligibleDomesticPrices
Get usps eligible domestic price as an asynchronous operation.
POST/api/v3/RateCalculator/postUspsSearchEligibleDomesticProducts
Get eligible usps domestic products as an asynchronous operation.

Return

GET/api/v1/Return/getCustomerDispositionChoiceTypes
Gets the customer disposition choice types.
GET/api/v1/Return/getReturnedOrderDetailByCustomerRma
Gets the returned order detail by customer rma.
GET/api/v1/Return/getReturnedOrderDetailByReturnId
Gets the returned order detail by return identifier.
GET/api/v1/Return/getReturnsAwaitingCustomerDispositionList
Gets all the returns awaiting customer disposition list.
GET/api/v1/Return/getReturnsListWithinDateRange
Gets the returns list.

Rma

GET/api/v1/Rma/getRmaList
Gets the rma list.
GET/api/v1/Rma/getRmaOrderDetailByCustomerRma
Gets the rma order detail by customer rma.
GET/api/v1/Rma/getRmaOrderDetailById
Retrieves the rma order detail by identifier.
POST/api/v1/Rma/postNewRmaOrder
Posts the new rma order.

ScanForm

POST/api/v3/ScanForm/postCreateUspsScanFormManifestMIDShipment
Create usps scan form manifest mailer identifier shipment as an asynchronous operation.
POST/api/v3/ScanForm/postCreateUspsScanFormMIDShipment
Create usps scan form mailer identifier shipment as an asynchronous operation.
POST/api/v3/ScanForm/postUspsCreateScanFormLabelShipment
Create usps scan form label shipment as an asynchronous operation.

Serial

GET/api/v1/Serial/getAllAvailableSerialScanBundlePartNumbersList
Retrieves the serial scan all available bundle part numbers list.
GET/api/v1/Serial/getAllAvailableSerialScanOperationsList
Gets the available serial scan operations list.
GET/api/v1/Serial/getAllAvailableSerialScanPartNumbersList
Gets the available serial scan part numbers list.

ServiceStandards

GET/api/v3/ServiceStandards/getUspsCustomerStandards
Get usps customer standards as an asynchronous operation.
GET/api/v3/ServiceStandards/getUspsGetDeliveryStandardsEstimates
Get usps delivery standards estimates as an asynchronous operation.
POST/api/v3/ServiceStandards/postFedExRetrieveServicesAndPackagingOptions
Retrieve FedEx services and package options as an asynchronous operation.
POST/api/v3/ServiceStandards/postFedExRetrieveServicesAndTransitTimes
Retrieve FedEx services and transit times as an asynchronous operation.
POST/api/v3/ServiceStandards/postFedExRetrieveSpecialServiceOptions
Retrieve FedEx special service options as an asynchronous operation.

Shipping

GET/api/v1/Shipping/getAllOrderShipConfirmsFilteredByDate
Gets all order ship confirms filtered by date.
GET/api/v1/Shipping/getShippedOrderList
Gets the shipped orders list.
GET/api/v1/Shipping/GetSingleOrderShipConfirm
Gets the ship confirm by order.
GET/api/v1/Shipping/getStagedOrderlist
Gets the staged orders list.
GET/api/v1/Shipping/getValidCustomerShipMethodsList
Gets the valid customer ship methods list.
POST/api/v3/Shipping/postFedExCreateNewReturnShipment
Create and deliver a FedEx return ship label to the customer, and then picks up the return as an asynchronous operation. Use this option to create tag requests for FedEx Express and FedEx Ground shipments.
POST/api/v3/Shipping/postFedExCreateNewShipment
Create a FedEx shipment as an asynchronous operation.
POST/api/v3/Shipping/postFedExRetrieveAsyncShipDataByJobId
Retrieve FedEx shipment data using a job identifier as an asynchronous operation.
POST/api/v3/Shipping/postFedExValidateShipment
Validate data accuracy of a FedEx shipment as an asynchronous operation.
POST/api/v3/Shipping/postUspsDomesticShippingOptionsSearch
Domestic shipping options search as an asynchronous operation.
POST/api/v3/Shipping/postUspsGenerateDomesticReturnsShippingLabel
Generate domestic returns shipping label as an asynchronous operation.
POST/api/v3/Shipping/postUspsGenerateDomesticShippingLabel
Generate usps domestic shipping label as an asynchronous operation.
PUT/api/v3/Shipping/putFedExCancelReturnShipment
Cancel a FedEx return tag and the associated pickup for FedEx Express and FedEx Ground shipments if the shipment has not yet been picked up by the courier as an asynchronous operation.
PUT/api/v3/Shipping/putFedExCancelShipment
Cancel a FedEx shipment request as an asynchronous operation.
DELETE/api/v3/Shipping/cancelUspsDomesticShipmentLabel
Cancel usps domestic shipment label as an asynchronous operation.

ShippingLabel

GET/api/v2/ShippingLabel/getLabelOrderStatusByOrderNumber
Gets the individual order status by order number.
GET/api/v2/ShippingLabel/getSingleUpsTrackingDetail
Gets the single ups tracking detail.
POST/api/v2/ShippingLabel/generateNewUpsShipLabel
Generates the new ups ship label.
POST/api/v2/ShippingLabel/postNewShipLabelOrder
Posts the new ship label order.
POST/api/v2/ShippingLabel/postUpsRateCheck
Performs the ups rate shopping.
POST/api/v2/ShippingLabel/postUpsVerifyAddress
Performs a ups address verify.

Subscription

GET/api/v3/Subscription/getUspsListAllSubscriptions
Get list all of USPS subscriptions as an asynchronous operation.
POST/api/v3/Subscription/postUspsCreateSubscriptionUsingMailerId
Creates a single USPS subscription by mailer identifier.
POST/api/v3/Subscription/postUspsCreateSubscriptionUsingTrackingNumber
Creates a single USPS subscription by tracking number.
PUT/api/v3/Subscription/putUspsEditSubscriptionByIdFilterByMailerId
Edit subscription by identifier filter by mailer identifier.
PUT/api/v3/Subscription/putUspsEditSubscriptionByIdFilterByTrackingNumber
Edit subscription by identifier filter by tracking number.
DELETE/api/v3/Subscription/deleteUspsSubscriptionById
Delete subscription by identifier asynchronous operation.

Tracking

GET/api/v3/Tracking/getUspsTrackingDetailInformation
Get usps tracking detail information (for a single tracking number) as an asynchronous operation.
GET/api/v3/Tracking/getUspsTrackingSummaryInformation
Get usps tracking summary information (for a single tracking number) as an asynchronous operation.
POST/api/v3/Tracking/postFedExRegisterForTrackingNotification
Registers for FedEx tracking notification as an asynchronous operation.
POST/api/v3/Tracking/postFedExRetrieveTrackDocumentByTrackingNumber
Get FedEx tracking document by tracking number as an asynchronous operation.
POST/api/v3/Tracking/postFedExRetrieveTrackingInfoByReference
Get FedEx tracking information by reference as an asynchronous operation.
POST/api/v3/Tracking/postFedExRetrieveTrackingInfoByTrackingNumber
Get FedEx tracking information by tracking number as an asynchronous operation.
POST/api/v3/Tracking/postFedExRetrieveTrackingInfoByTransportationControlNumber
Get FedEx tracking information for your Government orders by simply entering the (TCN) Transportation Control Number.
POST/api/v3/Tracking/postFedExRetrieveTrackingInfoForMultiPieceShipment
Get FedEx tracking information for a multi-piece shipment as an asynchronous operation.
POST/api/v3/Tracking/postUspsRegisterForTrackingNotification
Register for usps tracking notification as an asynchronous operation.

SDKs & sandbox

SDKs for C#, JavaScript/TypeScript, and more are planned. In the meantime, you can integrate directly with the REST endpoints above.

Need early access to sandbox keys or sample payloads? Contact sales and we’ll get you set up.

Loading…