Shipment Journey

This topic provides you detailed understanding of how Order APIs function when using the Acme eCommerce product. As a supplier, you can use these APIs to view the status of a shipment, estimated delivery date and the current transit location of the order. Acme's supplier service stores the shipment traking information which can be accessed via REST APIs and displayed as a shipment journey to your end-customer or just for your own reference.

Brief context

An order shipment journey represents all the functions that happen between the state when the order is successfully manifested and shipped from sender's location and until the said order is delivered to the customer.

Steps involved

The general flow for using the Shipment APIs are as follows:

1. Request for an authentication token.
2. User the relevant API methods and endpoints to access order status.

Gateway URL

The Acme API Gateway URL is https://api.acme.com/v1. You need to include this before each API endpoint to make API calls to Acme servers.

Authentication

Acme Corp uses OAuth 2.0 for authentication. To request for an authentication token, you need to include the unique Client ID and Secret Code along with the API request.

POST https://oauth.acme.com/oauth/token

Sample authentication request

{
    "client_id": "{CLIENT_ID}",
    "secret_code": "{CLIENT_SECRET_CODE}",
    "grant_type": "access_token"
}

Sample response

{
    "access_token": "token",
    "expires_in": 86400,
    "token_type": "supplier"
}

Header

Request body

Order APIs

Using the Order APIs suppliers can access the status of an order and its transit information which you can display to the end customers.

Get status API

This endpoint allows you to access the status of a shipment.

GET https://api.acme.com/v1/orderstatus/{count}

Sample request

curl -u [CLIENT_ID]:[CLIENT_SECRET_ID]\
  -X GET https://api.acme.com/v1/orderstatus/order?count=1

Sample response

{
    "general_order_information": {
        "transaction_id": "12-34567890123456789",
        "shop_order_id": "test-order-123",
        "shop_buyer_id": "test-buyer-123",
        "supplier_id": "test-supplier-123",
        "order_creation_date": "2022-03-10T18:06:52.438+01:00",
        "currency": "INR"
    }
}

Header

Request body

Path

Query

Response body

Errors