API Reference
OMS API
- POST /Auth/login — Get token
- POST /Orders/SaveOrders — Save order
- POST /Orders/SetOrderClientStatus — Write order client status
- POST /Orders/SetErpInfoList — Write ERP information
- POST /OrderPackage/CreatePackage — Create package
- GET /Orders/GetOrderPackages — List order packages
- POST /OrderPackage/SetPackageClientStatus — Write package client status
- POST /OrderPackage/SetOrderPackageStatusInfoList — Update package status (bulk)
- POST /OrderPackage/SetOrderPackageInvoiceInfoList — Write invoice information
- POST /OrderPackage/SetOrderPackageCargoInfoList — Write shipping information
- POST /OrderPackage/shipment-packages/{shipmentPackageId}/split — Split package (line-based)
- POST /OrderPackage/shipment-packages/{shipmentPackageId}/multi-split — Split the package into groups
- POST /OrderPackage/shipment-packages/{shipmentPackageId}/quantity-split — Split package by quantity
- POST /OrderPackage/shipment-packages/{shipmentPackageId}/split-packages — Create new packages with quantities from the package
- POST /Orders/CreateOrderItemLineCancelRequest — Create cancellation request
- POST /Orders/CancelOrderItemLineList — Cancel line
- POST /Return/CreateReturnRequest — Create return request
- GET /Orders/GetReturnOrderPackages — List return packages
- GET /Lookup/OrderStatusReasonByTenant/GetStatusReasonByType — List status reasons
TMS API
- POST /openapi/Auth/Login — Get token
- POST /openapi/Checkout/GetAvailableCarriersAndServiceTypes — Retrieve suitable carrier and service types
- POST /openapi/Order/SaveOrder — Save order
- POST /openapi/Order/QuickLabel — Quick label
- POST /openapi/Order/UnArchiveOrder — Restore archived order
- POST /openapi/Consignment/SaveConsignment — Record shipment
- POST /openapi/IntegrationHistory/GetTicketNumberStatus — Query record (ticket) status
- POST /openapi/Consignment/UpdateConsignmentAddress — Update consignment address
- POST /openapi/Consignment/UpdateConsignmentCarrier — Change shipment carrier
- POST /openapi/Consignment/UpdateShippingInfo — Update shipment information
- POST /openapi/Consignment/CancelConsignment — Cancel the shipment
- POST /openapi/Shipment/CancelShipmentOnCarrier — Cancel shipment at carrier
- POST /openapi/Shipment/RecallShipment — Recall shipment from carrier
- POST /openapi/Document/CreateLabel — Create label
- POST /openapi/Document/CreateLabelInAdvance — Create label in advance
- POST /openapi/Document/GetCreatedLabel — Retrieve created label
- POST /openapi/Consignment/GetConsignmentInfo — Order and shipment information
- POST /openapi/Shipment/GetShipmentStatus — Query package status
- POST /openapi/Report/GetShipmentReport — Changed shipments report
- POST /openapi/Shipment/UpdateShipmentVendorTrackingData — Report tracking information
- POST /openapi/Shipment/UpdateShipmentVendorTrackingDataAndCarrier — Notify tracking information and carrier
- POST /openapi/Shipment/UpdateShipmentStatusForAlternativeDelivery — Alternative delivery started
- POST /openapi/Shipment/UpdateAlternativeDeliveryToDelivered — Alternative shipment delivered
- POST /openapi/Shipment/UpdateShipmentAttributeData — Update shipment custom fields
- POST /openapi/DeliveryReceipt/UpdateShipmentDelivery — Enable/disable delivery receipt status
- POST /deliveryotpinfo — Delivery Point OTP Notification
- POST /openapi/Return/SaveReturnCode — Create return code
- POST /openapi/Return/GetReturnCodeStatus — Return status
- POST /openapi/Return/GetReturnLabel — Return label
- POST /openapi/Return/CancelReturnCode — Cancel return code
- POST /openapi/Return/GetAvailableReturnDates — Available return appointment dates
- GET /openapi/MasterData/GetPaymentTypes — Payment types
- GET /openapi/MasterData/GetCities — Cities
- POST /openapi/MasterData/GetTownsByCityCode — Districts
- POST /openapi/MasterData/GetDistrictsByCityTownCode — Neighborhoods
PIM API
- GET /Auth/GetUserDetails — Authenticate credentials
- POST /sapigw/suppliers/{supplierId}/v2/products — Bulk transfer products
- PUT /sapigw/suppliers/{supplierId}/v2/products — Bulk update products
- POST /PIM/SaveProductsManually — Save product (PIM model)
- POST /sapigw/suppliers/{supplierId}/products/price-and-inventory — Update price and stock
- GET /sapigw/suppliers/{supplierId}/products/batch-requests/{batchRequestId} — Query batch operation result
- GET /PIM/transaction/{transactionId}/summary — Query transaction summary
- GET /PIM/transaction/{transactionId}/product/summary — Query transaction product results
- POST /PIM/Vendor/Products — List supplier products
- POST /PIM/Vendor/Products/v2 — List vendor products (v2)
- POST /PIM/SaveExternalSku — Save ERP code to approved product
- GET /PIM/GetAttributes — List attributes
- POST /PIM/SaveAttributeWithDetail — Create or update attribute
- GET /PIM/Entity/List — Get lists
- GET /PIM/LookUp/ProductTypes — List product types
- GET /PIM/GetCurrencies — List currencies