Anchanto

Getting Started

Overview: Operations Experience (OXM)

API Reference

Authentication Flow

Orders

This API creates a new B2C order with details such as shipping type, carrier name, order items, and billing/shipping addresses.

Create New B2C Order

This API updates the details of an existing B2C order, including the shipping type, order number, and payment collection method.

Update B2C Order Details

This API retrieves the status of a B2C order using the order ID. It includes details about the order's state, tracking information, and associated products.

Retrieve B2C Order Status

This API creates a new B2B order with required details such as order type, carrier name, and order items.

Create New B2B Order

This API updates the details of an existing B2B order using the order ID.

Update B2B Order

This API retrieves the status of a B2B order using the order ID. It includes details on the order's current state, tracking details, and related events.

Retrieve B2B Order Status

This API creates a new shipment order with required details such as tracking number, purchase order, and shipper/receiver information.

Create New Shipment Order

This API updates the details of an existing shipment order using the order ID.

Confirm Shipment Order

This API updates the details of an existing shipment order, including tracking number, shipping rate, and custom information.

Update Shipment Order Details

This API retrieves the shipment status for a specified order ID. It provides details such as the tracking number, state transitions, and carrier information.

Retrieve Shipment Status

This API updates the status of an order and its shipment based on data received from the CS server. It supports various states including 'New', 'In-progress', 'Delivered', 'Cancelled', etc.

Update Order and Shipment Status

This API is usedd for creation of new shipment order coming from mintsoft

Shipment Registration

This API cancels an existing order using the order ID.

Cancel an Order

Retrieve All Orders

Products

This API registers a new product in the inventory. It requires details such as SKU, product name, quantity, category, and pricing.

Create New Product in Inventory

This API retrieves inventory stock details for a given product SKU, including usable quantity, buffer stock, and ATP stock.

Retrieve Inventory Stock Details

This API retrieves a list of products filtered by their type.

Retrieve Products by Type

This API updates the stock information for a product.

Update Product Stock

Customers

This API retrieves a list of customers based on their state (active, inactive, or onboarded). The list supports pagination and search features.

Retrieve Customer List by State

Inbounds

This API creates a new purchase order with details such as order type, supplier code, shipping date, and consignment items.

Create New Purchase Order

This API updates the status of an existing purchase order.

Update Purchase Order Status

This API retrieves the status of a specific purchase order by its order number, including consignment type, state, and related products.

Retrieve Purchase Order Status

This API retrieves a list of all purchase orders.

Retrieve All Purchase Orders

Suppliers

This API registers a new supplier in the system with required details like name, contact information, and address.

Register New Supplier

This API retrieves a list of suppliers filtered by their state (e.g., active, inactive).

Retrieve Suppliers by State

Returns

This API retrieves a list of returned orders.

Retrieve Returned Orders

Currencies

This API retrieves a list of supported currencies.

Retrieve Supported Currencies

This API retrieves a list of available units of measurement (UOMs).

Retrieve Units of Measurement

Swagger Petstore - OpenAPI 3.0

OXM-OpenAPIs

v1.1

<p class="slate-p " ><span style="color:rgb(0, 0, 0)">Welcome to the Operation Experience API documentation! This guide will help you get started with integrating and using the Operation Experience API in your applications.</span></p><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">Overview</span></h3><p class="slate-p " ><span style="color:rgb(0, 0, 0)">Operation Experience (OXM) provides a powerful set of APIs that allow you to manage and streamline your operational processes. The API offers various endpoints to perform operations related to orders, customers, suppliers, inventory, and more. By integrating your applications with OXM, you can automate your operations, improve efficiency, and deliver an exceptional experience to your customers.</span></p><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">API Authentication</span></h3><p class="slate-p " ><span style="color:rgb(0, 0, 0)">To access the Operation Experience API, you need to authenticate your requests using OAuth 2.0. Follow the steps below to obtain the necessary credentials:Contact the administrator to obtain the "Client ID" and "Client Secret" codes.Provide the administrator with the Redirect URL where you want to receive the authentication response.Once the administrator generates the Client ID and Client Secret, you will receive them for further API calls.</span></p><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">API Endpoints</span></h3><p class="slate-p " ><span style="color:rgb(0, 0, 0)">The Operation Experience API provides a range of endpoints to interact with different resources. Each endpoint represents a specific operation and supports various HTTP methods (GET, POST, PUT, DELETE). Here are some of the key endpoints available:</span><span style="color:rgb(0, 0, 0)"><strong class="slate-bold">Orders</strong></span><span style="color:rgb(0, 0, 0)">: Manage order creation, updates, tracking, and cancellation.</span><span style="color:rgb(0, 0, 0)"><strong class="slate-bold">Customers</strong></span><span style="color:rgb(0, 0, 0)">: Perform operations related to customer management, such as retrieving customer details, creating new customers, and updating customer information.</span><span style="color:rgb(0, 0, 0)"><strong class="slate-bold">Suppliers</strong></span><span style="color:rgb(0, 0, 0)">: Access supplier information, including supplier details, contact information, and supplier state.</span><span style="color:rgb(0, 0, 0)"><strong class="slate-bold">Inventory</strong></span><span style="color:rgb(0, 0, 0)">: Retrieve inventory details, update stock quantities, and track inventory movements.</span><span style="color:rgb(0, 0, 0)"><strong class="slate-bold">Authentication</strong></span><span style="color:rgb(0, 0, 0)">: Authenticate and obtain access tokens for API authorization.Please refer to the detailed API documentation for the full list of available endpoints, request/response examples, and parameter details.</span></p><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">API Usage</span></h3><p class="slate-p " ><span style="color:rgb(0, 0, 0)">To start using the Operation Experience API, you need to:Obtain an access token using the authentication endpoint.Include the access token in the authorization header of each API request.Make HTTP requests to the appropriate API endpoints, following the specified method, URL, and payload requirements.Handle API responses and process the data returned by the API.It's recommended to use an HTTP client library or tool of your choice to interact with the API endpoints efficiently. You can find code snippets and examples in the documentation to help you get started quickly.</span></p><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">Rate Limiting</span></h3><p class="slate-p " ><span style="color:rgb(0, 0, 0)">The Operation Experience API enforces rate limits to ensure fair usage and maintain system stability. The rate limits are based on the number of requests per minute (RPM) for each API endpoint. Please refer to the API documentation for the specific rate limits applicable to each endpoint.</span></p><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">Support</span></h3><p class="slate-p " ><span style="color:rgb(0, 0, 0)">If you have any questions, issues, or need further assistance regarding the Operation Experience API, please reach out to our support team via </span><span style="color:rgb(0, 0, 0)"><strong class="slate-bold">apisupport@anchanto.com</strong></span><span style="color:rgb(0, 0, 0)">. We are here to help you make the most of the API and ensure a seamless integration experience.That's it! You are now ready to explore the Operation Experience API and leverage its capabilities to optimize your operational workflows. Refer to the detailed API documentation for more in-depth information and start building amazing applications with Operation Experience.</span></p><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">Support Email Template</span></h3><p class="slate-p " ><span style="color:rgb(0, 0, 0)">To request any support form OXM team kindly send an email as it appears below: </span></p><p class="slate-p slate-indent-1" style="24px"><span style="color:rgb(0, 0, 0)"><code class="slate-code">TO:  </code></span><span style="color:rgb(0, 0, 0)"><code class="slate-code"><strong class="slate-bold">apisupport@anchanto.com</strong></code></span><span style="color:rgb(0, 0, 0)"><code class="slate-code"> </code></span></p><p class="slate-p slate-indent-1" style="24px"><span style="color:rgb(0, 0, 0)"><code class="slate-code">From: OXM customer registered email </code></span></p><p class="slate-p slate-indent-1" style="24px"><span style="color:rgb(0, 0, 0)"><code class="slate-code">First Name: </code></span></p><p class="slate-p slate-indent-1" style="24px"><span style="color:rgb(0, 0, 0)"><code class="slate-code">Last Name: </code></span></p><p class="slate-p slate-indent-1" style="24px"><span style="color:rgb(0, 0, 0)"><code class="slate-code">Client Id: </code></span></p><p class="slate-p slate-indent-1" style="24px"><span style="color:rgb(0, 0, 0)"><code class="slate-code">Product: </code></span></p><p class="slate-p slate-indent-1" style="24px"><span style="color:rgb(0, 0, 0)"><code class="slate-code">OXM Module: </code></span></p><p class="slate-p slate-indent-1" style="24px"><span style="color:rgb(0, 0, 0)"><code class="slate-code">Subject: </code></span></p><p class="slate-p slate-indent-1" style="24px"><span style="color:rgb(0, 0, 0)"><code class="slate-code">Description: </code></span></p><p class="slate-p slate-indent-1" style="24px"><span style="color:rgb(0, 0, 0)"><code class="slate-code">Attachments if any:</code></span></p><p class="slate-p " ></p><p class="slate-p " ></p>

Welcome to the Operation Experience API documentation! This guide will help you get started with integrating and using the Operation Experience API in your applications.

Operation Experience (OXM) provides a powerful set of APIs that allow you to manage and streamline your operational processes. The API offers various endpoints to perform operations related to orders, customers, suppliers, inventory, and more. By integrating your applications with OXM, you can automate your operations, improve efficiency, and deliver an exceptional experience to your customers.

To access the Operation Experience API, you need to authenticate your requests using OAuth 2.0. Follow the steps below to obtain the necessary credentials:Contact the administrator to obtain the "Client ID" and "Client Secret" codes.Provide the administrator with the Redirect URL where you want to receive the authentication response.Once the administrator generates the Client ID and Client Secret, you will receive them for further API calls.

The Operation Experience API provides a range of endpoints to interact with different resources. Each endpoint represents a specific operation and supports various HTTP methods (GET, POST, PUT, DELETE). Here are some of the key endpoints available:

: Manage order creation, updates, tracking, and cancellation.

: Perform operations related to customer management, such as retrieving customer details, creating new customers, and updating customer information.

: Access supplier information, including supplier details, contact information, and supplier state.

: Retrieve inventory details, update stock quantities, and track inventory movements.

: Authenticate and obtain access tokens for API authorization.Please refer to the detailed API documentation for the full list of available endpoints, request/response examples, and parameter details.

To start using the Operation Experience API, you need to:Obtain an access token using the authentication endpoint.Include the access token in the authorization header of each API request.Make HTTP requests to the appropriate API endpoints, following the specified method, URL, and payload requirements.Handle API responses and process the data returned by the API.It's recommended to use an HTTP client library or tool of your choice to interact with the API endpoints efficiently. You can find code snippets and examples in the documentation to help you get started quickly.

The Operation Experience API enforces rate limits to ensure fair usage and maintain system stability. The rate limits are based on the number of requests per minute (RPM) for each API endpoint. Please refer to the API documentation for the specific rate limits applicable to each endpoint.

If you have any questions, issues, or need further assistance regarding the Operation Experience API, please reach out to our support team via 

. We are here to help you make the most of the API and ensure a seamless integration experience.That's it! You are now ready to explore the Operation Experience API and leverage its capabilities to optimize your operational workflows. Refer to the detailed API documentation for more in-depth information and start building amazing applications with Operation Experience.

To request any support form OXM team kindly send an email as it appears below: 

The table describes a set of operations involving an Open API, OXM and a third-party system (3P system). It outlines the inbound and outbound systems, API endpoints, and associated events for each operation. These operations facilitate order creation and cancellation, inventory updates, order status updates, purchase order management, and coordination between the systems involved It also mentions the use of open APIs (Application Programming Interfaces) and webhooks for integration purposes.

<p class="slate-p " ><span style="color:rgb(0, 0, 0)">The Authentication API allows users to obtain an access token for authentication purposes.</span></p><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">Step 1: Get Client ID and Client Secret</span></h3><p class="slate-p " ><span style="color:rgb(0, 0, 0)">To use the Authentication API, you need to obtain the Client ID and Client Secret codes from the Admin. Follow the steps below:</span></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)">Provide the Redirect URL: Share the Redirect URL with the Admin. This URL is required to generate the Client ID and Client Secret codes.</span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)">Enter the Redirect URL in the Admin Portal: The Admin will enter the provided Redirect URL in the Admin Portal.</span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)">Generate Client ID and Client Secret: The Admin will generate the Client ID and Client Secret codes for your application.</span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)">Share Client ID and Client Secret: Once generated, the Admin will provide you with the Client ID and Client Secret codes. Keep these codes secure as they are required for further API calls.</span></div></li></ol><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">Step 2: Get Access Token</span></h3><p class="slate-p " ><span style="color:rgb(0, 0, 0)">To obtain an access token, make a </span><span style="color:rgb(0, 0, 0)"><code class="slate-code">POST</code></span><span style="color:rgb(0, 0, 0)"> request to the following endpoint:</span></p><div class="code-block-wrapper" style="width:100%"><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-antlr4 keep-markup drop-tokens"><div class="slate-code_line"><span style="color:rgb(0, 0, 0)">https://cep-uat-api.anchanto.com/external-api/v1/oauth/token</span></div></code></pre></div><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">Request</span></h3><p class="slate-p " ><span style="color:rgb(0, 0, 0)">Insert line aboveInsert line belowDelete</span></p><div class="code-block-wrapper" style="width:100%"><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line"><span style="color:rgb(0, 0, 0)">cURLcurl --location --request POST 'https://cep-uat-api.anchanto.com/external-api/v1/oauth/token' \--header 'Authorization: Basic JDJiJDEyJHZwZzVjT0xkN3VTS1hybXBqU2RQUi5XNVcyOU9URWlBenRpei44WTJyWkJVSWtTZTFFY2txOiQyYiQxMiRyNTlkSUpBT3BtWVZvLmhkci9jMUN1QUlIY3k4ZDBwdy9PazhTLkNtcFdVZlUyZko3MXFzTw==' \--header 'Content-Type: application/x-www-form-urlencoded' \--data-urlencode 'username=sharad.patil+uatcontact@anchanto.com' \--data-urlencode 'grant_type=password' \--data-urlencode 'password=Sharad@123'</span></div></code></pre></div><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">Request Headers</span></h3><p class="slate-p " ><span style="color:rgb(0, 0, 0)">Insert line aboveInsert line belowDelete</span></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)"><code class="slate-code">Authorization</code></span><span style="color:rgb(0, 0, 0)">: The value should be the Base64 encoded string of "Client ID:Client Secret".</span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)"><code class="slate-code">Content-Type</code></span><span style="color:rgb(0, 0, 0)">: Set to </span><span style="color:rgb(0, 0, 0)"><code class="slate-code">application/x-www-form-urlencoded</code></span><span style="color:rgb(0, 0, 0)">.</span></div></li></ul><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">Request Body Parameters</span></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)"><code class="slate-code">username</code></span><span style="color:rgb(0, 0, 0)">: The username or email associated with the account.</span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)"><code class="slate-code">grant_type</code></span><span style="color:rgb(0, 0, 0)">: Set to </span><span style="color:rgb(0, 0, 0)"><code class="slate-code">password</code></span><span style="color:rgb(0, 0, 0)">.</span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)"><code class="slate-code">password</code></span><span style="color:rgb(0, 0, 0)">: The password for the account.</span></div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">Response</span></h3><p class="slate-p " ><span style="color:rgb(0, 0, 0)">Upon successful authentication, you will receive a response containing the access token.</span></p><div class="code-block-wrapper" style="width:100%"><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><span style="color:rgb(0, 0, 0)">{</span></div><div class="slate-code_line"><span style="color:rgb(0, 0, 0)">  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",  </span></div><div class="slate-code_line"><span style="color:rgb(0, 0, 0)">  "token_type": "Bearer",</span></div><div class="slate-code_line"><span style="color:rgb(0, 0, 0)">  "expires_in": 3600,</span></div><div class="slate-code_line"><span style="color:rgb(0, 0, 0)">  "refresh_token": "nNshdjGjs...kdsGF4sjd"</span></div><div class="slate-code_line"><span style="color:rgb(0, 0, 0)">}</span></div></code></pre></div><h3 class="slate-h3 " ><span style="color:rgb(0, 0, 0)">Response Fields</span></h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)"><code class="slate-code">access_token</code></span><span style="color:rgb(0, 0, 0)">: The access token to be used for subsequent API calls. Include this token in the </span><span style="color:rgb(0, 0, 0)"><code class="slate-code">Authorization</code></span><span style="color:rgb(0, 0, 0)">header as a Bearer token.</span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)"><code class="slate-code">token_type</code></span><span style="color:rgb(0, 0, 0)">: The type of token, which is usually "Bearer".</span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)"><code class="slate-code">expires_in</code></span><span style="color:rgb(0, 0, 0)">: The expiration time of the access token in seconds.</span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:rgb(0, 0, 0)"><code class="slate-code">refresh_token</code></span><span style="color:rgb(0, 0, 0)">: The refresh token that can be used to obtain a new access token when the current one expires.</span></div></li></ul><p class="slate-p " ><span style="color:rgb(0, 0, 0)">Note: The access token should be included in the </span><span style="color:rgb(0, 0, 0)"><code class="slate-code">Authorization</code></span><span style="color:rgb(0, 0, 0)"> header of all subsequent API requests as follows:</span></p><div class="code-block-wrapper" style="width:100%"><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><code class="language-plainText keep-markup drop-tokens"><div class="slate-code_line"><span style="color:rgb(0, 0, 0)">Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...</span></div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

The Authentication API allows users to obtain an access token for authentication purposes.

To use the Authentication API, you need to obtain the Client ID and Client Secret codes from the Admin. Follow the steps below:

Upon successful authentication, you will receive a response containing the access token.

Note: The access token should be included in the 

 header of all subsequent API requests as follows:

result

level

message

data

Http status 200 indicates api called successfully

authorization parameter is missing or invalid or expired

Sections