Note: You are viewing an older version of the documentation. Click here to go the latest version
Order
Manages orders, including processing, tracking, and updating order status.
Operations
GET
# Get ordering source config for a given company and application.
PUT
# Update ordering source config for a given company and application.
GET
# List ordering sources for a given company and application.
Retrieves the ordering source config for a given company and application.
Parameters
company_idpath
string
Required
application_idpath
string
Required
slugpath
string
Required
GET
Response
200
The request was successful, and the response contains the ordering source config.
Hide
Ordering source config for a given company and application.
slug
string
Slug of the ordering source.
configs
array of object (OrderingSourceFeature)
Show
Ordering source config item for a given company and application.
name
string
Name of the ordering source config item.
slug
string
Slug of the ordering source config item.
Enum
description
string
Description of the ordering source config item.
enabled
boolean
Whether the config/feature is enabled or not.
logo
string
Logo of the ordering source.
Examples
Parameters
company_id:
"1"
application_id:
"6573205f9217394923560aae"
slug:
"gofynd"
Response
Get ordering source config for a given company and application.
getOrderingSourceConfigBySlug
Updates the ordering source config for a given company and application.
Parameters
company_idpath
string
Required
application_idpath
string
Required
slugpath
string
Required
bodyrequestBody
object (OrderingSourceConfig)
Required
Hide
Ordering source config for a given company and application.
slug
string
Slug of the ordering source.
configs
array of object (OrderingSourceFeature)
Show
Ordering source config item for a given company and application.
name
string
Name of the ordering source config item.
slug
string
Slug of the ordering source config item.
Enum
description
string
Description of the ordering source config item.
enabled
boolean
Whether the config/feature is enabled or not.
logo
string
Logo of the ordering source.
Request body
slug
string
Slug of the ordering source.
configs
array of object (OrderingSourceFeature)
Show
Ordering source config item for a given company and application.
name
string
Name of the ordering source config item.
slug
string
Slug of the ordering source config item.
Enum
description
string
Description of the ordering source config item.
enabled
boolean
Whether the config/feature is enabled or not.
logo
string
Logo of the ordering source.
PUT
Response
200
The request was successful, and the response contains the ordering source config.
Hide
Ordering source config for a given company and application.
slug
string
Slug of the ordering source.
configs
array of object (OrderingSourceFeature)
Show
Ordering source config item for a given company and application.
name
string
Name of the ordering source config item.
slug
string
Slug of the ordering source config item.
Enum
description
string
Description of the ordering source config item.
enabled
boolean
Whether the config/feature is enabled or not.
logo
string
Logo of the ordering source.
Examples
Parameters
company_id:
"1"
application_id:
"6573205f9217394923560aae"
slug:
"gofynd"
body:
body
Response
Update ordering source config for a given company and application.
updateOrderingSourceConfigBySlug
Retrieves the list of ordering sources for a given company and application.
Parameters
company_idpath
string
Required
application_idpath
string
Required
typequery
string
Enum
page_noquery
integer
page_sizequery
integer
GET
Response
200
The request was successful, and the response contains the ordering source config.
Hide
items
array of object (OrderingSourceSummary)
Show
text
string
Display Text of the ordering source.
value
string
Value of the ordering source.
page
object (Page)
Show
An object representing a page with pagination details.
item_total
integer
| int32
The total number of all items across all pages.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, can be 'cursor' or 'number'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
"1"
application_id:
"6573205f9217394923560aae"
type:
"SALES_CHANNEL"
page_no:
1
page_size:
100
Response
List ordering sources for a given company and application.
listOrderingSources
Return Merchandise Authorization (RMA) enables you to create and manage rules that define the specific reasons and sub-reasons to present to customers during a return process. These rules also allow you to specify an optional quality control (QC) mechanism to ensure that the returned merchandise meets the required standards before processing the return.
Operations
POST
# List of RMA rules based on the given input conditions.
Retrieves a comprehensive list of RMA (Return Merchandise Authorization) rules associated with a specific company and application. These rules dictate the processes for handling returns, including actions, reasons, quality control (QC) types, and associated questions. The endpoint allows for filtering and pagination based on input conditions, providing a tailored set of rules that match the criteria specified.
Parameters
company_idpath
string
Required
application_idpath
string
Required
bodyrequestBody
object (RuleListRequestSchema)
Required
Hide
page_no
integer
The page number to be retrieved. This determines the starting point for the list of rules to be returned.
channel
array of string
An array of channel (application ID) identifiers. These channels represent the specific application contexts for which the rules are being requested.
department
array of string
An array of department identifiers. The rules returned will be applicable to these specified departments.
id
array of string
An array of rule identifiers. This allows for retrieving specific rules based on their unique IDs.
is_active
boolean
Indicates whether the rules to be retrieved are active. This flag helps filter the rules based on their current status.
Request body
page_no
integer
The page number to be retrieved. This determines the starting point for the list of rules to be returned.
channel
array of string
An array of channel (application ID) identifiers. These channels represent the specific application contexts for which the rules are being requested.
department
array of string
An array of department identifiers. The rules returned will be applicable to these specified departments.
id
array of string
An array of rule identifiers. This allows for retrieving specific rules based on their unique IDs.
is_active
boolean
Indicates whether the rules to be retrieved are active. This flag helps filter the rules based on their current status.
POST
Response
200
400
The request was successful, and the response contains a list of RMA rules that match the specified criteria, along with pagination details.
Hide
Contains the rules related to RMA (Return Merchandise Authorization). These rules define the conditions, actions, and quality checks that need to be enforced during the RMA process. Each rule specifies a combination of reasons, quality control types, associated questions, and other necessary attributes that govern the return and exchange of merchandise. The response also includes pagination information to manage large sets of rules, along with a success indicator and error details if applicable.
page
object (RMAPageInfo)
Provides information about the pagination of the rule list. This includes details like the current page, the total number of items, and whether there are previous or next pages available.
Show
Provides information about the pagination of a list of items in the response. This helps in understanding how the data is segmented across multiple pages.
type
string
The type of pagination used. Common values could be "number" for numeric pagination, which indicates that the pages are numbered sequentially.
current
integer
The current page number being displayed. This reflects the page of data currently being viewed.
size
integer
The number of items per page. This sets the limit on how many rule items are shown on each page.
item_total
integer
The total number of items available. This provides an overview of the entire dataset from which the rules are being paginated.
has_previous
boolean
Indicates whether there are previous pages available before the current page. It helps in navigating backward through the data.
has_next
boolean
Indicates whether there are more pages available after the current page. It helps in determining if there is more data to be viewed.
items
array of object (RuleItem)
A list of rule items included in the response. Each item represents a specific RMA rule, detailing its unique identifier, entity type, associated actions, conditions, and other relevant attributes. This list is essential for understanding the individual rules that are applied within the system for return merchandise authorization.
Show
Represents an individual rule item, including its ID, type, value, associated actions, and various attributes. This object encapsulates all the necessary information about a rule.
id
string
The unique identifier for the rule item. This ID is essential for referencing and managing individual rules.
entity_type
string
The type of entity the rule applies to, such as "department" or "l3". This specifies the scope of the rule.
Enum
value
string
The value associated with the entity type, such as a department ID or L3 category ID. This value determines the specific context in which the rule is applied.
channel
string
The channel (application ID) to which the rule applies. This links the rule to a specific sales channel or application.
actions
object (RuleAction)
The actions and reasons associated with the rule. These define what happens when the rule is triggered.
Show
A list of reasons and actions associated with the rule. Each reason provides detailed information about why the rule is applied and what conditions or checks are involved. This structure helps in understanding the logic behind each rule and its associated actions.
reasons
array of object (Reason)
Show
id
integer
A unique identifier for the reason.
display_name
string
The display name for the reason, used for user-facing purposes.
reasons
array of object (Reason)
A list of sub-reasons under the main reason. These provide additional layers of granularity to the main reason.
Show
qc_type
array of string
List of QC (Quality Control) types -- having return reason types indicating the stage at which QC is performed. - "Doorstep QC" refers involves inspecting products for damages at the customer's location before delivery. - "Pre QC" requires customers to upload product photos for a preliminary quality check by the operations team before a return or exchange pickup is arranged, ensuring criteria are met and optimizing logistics.
Enum
question_set
array of object (QuestionSet)
An array of question sets linked to the reason, defining the questions to be answered.
Show
id
integer
A unique identifier for the question set.
display_name
string
The display name for the question set, used for user-facing purposes.
meta
object
Meta object of the reason. This contains any additional metadata that might be relevant to the reason.
is_active
boolean
Indicates whether the reason is currently active. Active reasons are those that are currently in use within the system.
qc_enabled
boolean
Indicates whether quality checks are enabled for this rule. If enabled, the rule includes quality control mechanisms.
is_deleted
boolean
Indicates whether the rule is deleted. Deleted rules are no longer active or enforceable.
conditions
object (Conditions)
Show
Conditions associated with the rule. These conditions determine when and how the rule is applied.
department
string
The department ID to which the rule applies. This helps in filtering the rules based on specific departments.
l3
string
The Level 3 category ID to which the rule applies. This further refines the application of the rule within a specific category.
meta
object
Metadata associated with the rule. This provides additional context and information related to the rule.
rule_type
string
The type of rule, such as "custom" or "global". This specifies whether the rule is a custom one or a global standard.
Enum
is_active
boolean
Indicates whether the rule is currently active. Active rules are those that are currently being enforced.
success
boolean
Indicates whether the request was successful. A value of `true` means the rules were retrieved successfully, while `false` indicates an error occurred during the request.
error
object (RuleError)
Contains error details if the request was not successful. This includes the type of error, the value that caused the issue, and a message explaining the error. These details help in diagnosing and resolving issues that may arise when retrieving the rules.
Show
Contains details about an error that occurred during the request, including the error type, value, and message. This object helps in diagnosing and understanding the issues that arise during API interactions.
type
string
The type of error encountered. This could be related to validation, processing, or other issues.
value
string
A specific value related to the error. This provides context to the error, such as which input was problematic.
message
string
The error message that describes what went wrong. This message is intended for developers or users to understand the issue.
Response
List of RMA rules based on the given input conditions.
getRules
Shipment represents the physical movement of goods from the seller (or your warehouse) to the customer. It's associated with a specific order and includes details like tracking information, carrier used, weight, dimensions, and estimated delivery date. An Order can contain multiple shipments. Shipments are created based on multiple factors like selling location assigned to that shipment, the packaging material available etc. A shipment will get created whenever there is a partial transition of items also when there is a negative state transition is invoked. Negative state transition can be defined against a state. Currently only some defined states are configured as negative. If any state is to be added as negative state then please contact support team.
Operations
GET
# Retrieve Reasons for Cancellation and Return journey
GET
# List sales channel shipments
GET
# Track shipment
GET
# List shipment cancellation reasons
Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations.
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
application_idpath
string
Required
A unique identifier for the application on the platform
shipment_idpath
string
Required
The unique identifier for the shipment
line_numberpath
integer
Required
A unique identifier of the bag's line number.
GET
Response
200
A successful response
Hide
reasons
array of object (BagReasons)
List of bag reasons for a shipment with a corresponding shipment status.
Show
qc_type
array of string
List of QC (Quality Control) types -- having return reason types indicating the stage at which QC is performed. - "Doorstep QC" refers involves inspecting products for damages at the customer's location before delivery. - "Pre QC" requires customers to upload product photos for a preliminary quality check by the operations team before a return or exchange pickup is arranged, ensuring criteria are met and optimizing logistics.
Enum
id
integer
A unique identifier for the bag reason.
display_name
string
The display name for the bag reason, used for user-facing purposes.
meta
object (BagReasonMeta)
Show
Additional metadata related to the reason, which may include specific conditions or configurations.
show_text_area
boolean
Indicates whether a text area should be displayed for additional input related to the bag reason.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
question_set
array of object (QuestionSet)
An array of question sets linked to the bag reason, defining the questions to be answered.
Show
id
integer
A unique identifier for the question set.
display_name
string
The display name for the question set, used for user-facing purposes.
reasons
array of object (BagReasons)
An array of nested bag reasons that can further explain the primary reason.
Show
success
boolean
Indicates whether the API call was successful (true) or not (false).
rule_id
integer
Nullable
The unique identifier for the rule that is associated with the given reasons. This ID serves as a reference to the specific rule within the RMA system that governs or influences the reasons listed.
Examples
Parameters
company_id:
1
application_id:
"5d63686df2a4f7806b76bb32"
shipment_id:
"17290285081731219531"
line_number:
1
Response
Retrieve Reasons for Cancellation and Return journey
getShipmentBagReasons
Get shipments of a particular sales channel based on the filters provided
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
application_idpath
string
Required
A unique identifier for the application or system that is making the order request.
lanequery
string
Optional parameter to specify the lane for filtering results.
search_typequery
string
search_type refers to the field that will be used as the target for the search operation
Enum
search_idquery
string
Identifier used for the search operation based on the selected search type.
from_datequery
string
| date
Date time in UTC timezone as per ISO format.
to_datequery
string
| date
Date time in UTC timezone as per ISO format.
dp_idsquery
string
Comma-separated list of delivery partner IDs to filter results.
ordering_company_idquery
string
ID of the company placing the order, used for filtering results.
storesquery
string
Comma-separated list of store IDs to filter results.
sales_channelquery
string
The sales channel to filter results.
request_by_extquery
string
Identifier for external requests.
page_noquery
integer
The page number for pagination of results.
page_sizequery
integer
The number of results to return per page for pagination.
customer_idquery
string
ID of the customer to filter results related to specific customer.
is_priority_sortquery
boolean
Flag to determine if results should be sorted by priority. Defaults to true.
Default Value : true
exclude_locked_shipmentsquery
boolean
Flag to exclude shipments that are currently locked from the results.
Default Value : true
GET
Response
200
We are processing the report!
Hide
total_count
integer
Nullable
The total number of shipments matching the query criteria. Returned as -1 when `include_count=false`.
message
string
Nullable
A message providing additional context about the response.
success
boolean
Nullable
Indicates whether the API call was successful (true) or not (false).
items
array of object (ShipmentItem)
An array of shipment items returned as part of the response.
Show
order_date
string
| date-time
Nullable
Denotes the date and time when an order was placed by the customer. This timestamp is crucial for tracking the order'
order_created_ts
string
| date-time
Nullable
The timestamp indicating when the order was created in UTC format.
ordering_source_details
object (OrderingSourceDetails)
Show
type
string
Type of the ordering source.
Enum
slug
string
Slug identifier of the ordering source.
display_name
string
Display name of the ordering source.
is_active
boolean
Indicates whether the ordering source is active.
logo
string
| uri
Logo URL of the ordering source.
shipment_status
object (ShipmentStatus)
Show
current_shipment_status
string
Nullable
The current status of the shipment.
meta
object
Nullable
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
id
integer
Nullable
A unique identifier for the shipment status.
bag_list
array of string
Nullable
A list of bags associated with the shipment, useful for tracking individual items within the shipment.
title
string
A brief title or label for the shipment status, summarizing its current state.
display_name
string
A user-friendly name or identifier for the shipment status.
created_at
string
| date-time
Nullable
Timestamp when the shipment was initially created.This timestamp is crucial for tracking the shipment's age, scheduling, and historical analysis.
created_ts
string
Nullable
A general timestamp for when the shipment was created, formatted for internal processing.
shipment_id
string
Nullable
A unique identifier for the shipment.
status_created_at
string
| date-time
Nullable
Timestamp when the transition for the status of the shipment was created. Date time in UTC timezone as per ISO format.
updated_ts
string
Nullable
A general timestamp indicating when the status was updated, useful for processing and tracking.
status
string
This key denotes the status of the shipment, providing a clear indication of its current processing stage.
user
object (UserDataInfo)
Show
Contains the details of the user who created the order including identifying information and relevant metadata.
id
integer
Nullable
The unique identifier associated with the user.
user_oid
string
Nullable
The object ID for the user, used for referencing the user in various operations.
mongo_user_id
string
Nullable
The identifier for the user.
external_customer_id
string
Nullable
The identifier for the user in external systems.
first_name
string
Nullable
The first name of the user.
last_name
string
Nullable
The last name of the user.
mobile
string
Nullable
The mobile phone number of the user.
email
string
Nullable
The email address of the user.
meta
object
Nullable
Additional metadata related to the user.
is_anonymous_user
boolean
Nullable
Indicates whether the user is an anonymous user (true) or registered (false).
name
string
Nullable
A full name of the user, which may be a combination of first and last name.
gender
string
Nullable
The gender of the user.
country_phone_code
string
The country-specific phone code, useful for formatting mobile numbers correctly.
estimated_sla_time
string
Nullable
The estimated Service Level Agreement (SLA) time for the shipment.
estimated_sla_ts
string
Nullable
The timestamp for the estimated SLA, providing a specific time for expected delivery in UTC format.
delivery_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
Category or classification of the address. The address_category field
that includes "store", "delivery", and "billing" serves to classify
addresses based on various business processes.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
billing_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
Category or classification of the address. The address_category field
that includes "store", "delivery", and "billing" serves to classify
addresses based on various business processes.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
affiliate_details
object (AffiliateDetails)
Show
Details of an affiliate associated with a shipment.
shipment_meta
object (ShipmentMeta)
Show
tracking_url
string
Nullable
A URL for tracking the shipment.
estimated_delivery_date
string
| date-time
Nullable
Provides a forecasted date and time by which the shipment is expected to be delivered to the recipient. This estimation is crucial for planning purposes, both for the sender in managing expectations and for the recipient in preparing for receipt.
same_store_available
boolean
Indicates whether the shipment is available for pickup from the same store.
b2b_buyer_details
object (BuyerDetails)
Show
ajio_site_id
string
Nullable
The unique identifier for the buyer on the Ajio platform.
pincode
integer
The postal code for the buyer's shipping address, used for delivery location identification.
address
string
Provides the comprehensive address details of the buyer's shipping address.
gstin
string
The Goods and Services Tax Identification Number (GSTIN) of the buyer.
name
string
The full name of the buyer, essential for personalizing communication and delivery.
state
string
The name of the state where the buyer's shipping address is located, important for logistical purposes.
city
string
The name of the city where the buyer's shipping address is located, which helps in identifying delivery zones.
formatted
object (Formatted)
Show
max
string
Nullable
Represents the maximum formatted value, providing a limit for the associated data, such as dimensions or weights.
min
string
Nullable
Represents the minimum formatted value, establishing a lower limit for the associated data, ensuring it meets certain criteria or standards.
debug_info
object (DebugInfo)
Show
stormbreaker_uuid
string
Nullable
A unique identifier (UUID) associated with the Stormbreaker system, used for tracking and debugging purposes in the application.
return_awb_number
string
Nullable
The Air Waybill (AWB) number associated with a return shipment.
is_self_ship
boolean
Nullable
Indicates whether the shipment is a self-shipped order.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
einvoice_info
object (EinvoiceInfo)
Show
credit_note
object
Nullable
Specifies the reverse einvoice transaction create on government portal.
invoice
object
Nullable
It specifies the forward einvoice transaction created on government portal.
return_affiliate_shipment_id
string
Nullable
The shipment ID associated with a return from an affiliate.
parent_dp_id
string
Nullable
The unique identifier for the parent delivery partner.
shipment_weight
number
Nullable
The total weight of the shipment.
dimension
object (Dimensions)
Show
height
number
Nullable
The height measurement of the object, typically representing the vertical dimension.
width
number
Nullable
The width measurement of the object, indicating the horizontal dimension.
is_default
boolean
Nullable
A flag indicating whether these dimensions are the default measurements for the object.
unit
string
Nullable
The unit of measurement used for the dimensions (e.g., centimeters, inches).
length
number
Nullable
The length measurement of the object, representing the longest dimension.
dp_options
object
Nullable
Delivery partner options that are available to deliver the shipment.
assign_dp_from_sb
boolean
Nullable
Indicates whether to assign the delivery partner from the store’s basket.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
store_invoice_updated_date
string
| date-time
Nullable
Denotes the date and time when the store's invoice related to this shipment was updated. This timestamp is vital for tracking changes to billing details, adjustments in charges, or updates in the invoicing status.
forward_affiliate_shipment_id
string
Nullable
The shipment ID for the forward journey of an affiliate shipment.
return_store_node
integer
Nullable
The identifier for the store node involved in the return process.
fulfilment_priority_text
string
Nullable
Textual representation of the fulfillment priority for the shipment.
shipment_tags
array of object (ShipmentTags)
Tags associated with the shipment for categorization and filtering.
Show
slug
string
Nullable
A URL-friendly string representing the tag, often used for routing or categorization.
entity_type
string
Nullable
Type of entity that the tag is associated to (bag, shipments).
Enum
display_text
string
Nullable
A human-readable text representation of the tag, used for display purposes in user interfaces.
external
object
Nullable
External metadata related to the shipment.
awb_number
string
Nullable
The Air Waybill number associated with the shipment.
lock_data
object (LockData)
Show
locked
boolean
Nullable
Indicates whether the shipment is currently locked for processing (true) or not (false).
mto
boolean
Nullable
A flag indicating whether the shipment is part of a multi-modal transport operation.
lock_message
string
Nullable
An optional message providing additional context or information regarding the lock status.
order_type
string
Nullable
Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow.
Enum
ewaybill_info
object
Nullable
Electronic Way Bill details i.e ewayBillNo, ewayBillDate that are utilized in the transportation of goods.
dp_id
string
Nullable
The unique identifier for the delivery partner associated with the shipment.
shipment_volumetric_weight
number
Nullable
The volumetric weight of the shipment, which may differ from its actual weight.
marketplace_store_id
string
Nullable
The unique identifier for the marketplace store associated with the shipment.
return_details
object
Nullable
An object containing the return details of the shipment.
dp_sort_key
string
Nullable
A sort key for the delivery partner, used for prioritization.
packaging_name
string
Nullable
The name of the packaging used for the shipment.
timestamp
object (ShipmentTimeStamp)
Show
max
integer
Nullable
Represents the maximum timestamp value, indicating the latest time relevant to the shipment.
min
integer
Nullable
Represents the minimum timestamp value, indicating the earliest time relevant to the shipment.
auto_trigger_dp_assignment_acf
boolean
Nullable
Indicates whether automatic delivery partner assignment is triggered for this shipment.
dp_name
string
Nullable
The name of the delivery partner associated with the shipment.
po_number
string
Nullable
The purchase order number associated with the shipment.
weight
integer
The weight of the shipment, typically measured in grams or kilograms.
b2c_buyer_details
object
Nullable
Contains detailed information about the buyer in a business-to-consumer (B2C) transaction. This object is designed to capture a wide array of buyer-specific data such as contact information, shipping address, preferences, and any other relevant details that enhance the understanding of the buyer's profile and needs.
forward_affiliate_order_id
string
Nullable
The order ID for the forward journey of an affiliate shipment.
return_affiliate_order_id
string
Nullable
The order ID for the return journey of an affiliate shipment.
bag_weight
object
Nullable
This object is designed to accommodate a range of weight-related information. Denotes the weight of the bag, potentially including various measurements or related details.
refund_to
string
Nullable
Specifies the recipient of any refunds related to the shipment.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
affiliate_shipment_id
string
The shipment ID specific to this affiliate.
company_affiliate_tag
string
Nullable
An optional tag representing the company's affiliate association.
affiliate_order_id
string
The order ID associated with the affiliate shipment.
pdf_links
object (PDFLinks)
Show
invoice_type
string
The type of invoice issued, such as 'fynd' or other classifications.
Enum
label_a6
string
Nullable
URL or path to the A6 size label document.
invoice
string
Nullable
URL or path to the main invoice document.
label_pos
string
Nullable
URL or path to the POS label document.
invoice_a6
string
Nullable
URL or path to the A6 size invoice document.
b2b
string
Nullable
URL or path to the B2B document related to the transaction.
label
string
Nullable
URL or path to the general label document.
label_a4
string
Nullable
URL or path to the A4 size label document.
label_type
string
Specifies the type of label associated with a PDF document,indicating its purpose or content. The label_type helps in organizing and identifying PDF documents quickly, ensuring that users or systems can efficiently utilize the correct documents for required actions.
Enum
invoice_export
string
Nullable
URL or path to the exported invoice document.
credit_note_url
string
Nullable
URL or path to the credit note document.
delivery_challan_a4
string
Nullable
URL or path to the A4 delivery challan document.
label_export
string
Nullable
URL or path to the exported label document.
invoice_a4
string
Nullable
URL or path to the A4 size invoice document.
invoice_pos
string
Nullable
URL or path to the POS invoice document.
po_invoice
string
Nullable
URL or path to the purchase order invoice document.
config
object (AffiliateConfig)
Show
app
object (AffiliateAppConfig)
Show
id
string
description
string
updated_at
string
| date-time
The date and time when the app config was updated.
name
string
token
string
meta
array of object (AffiliateAppConfigMeta)
Show
value
string
name
string
owner
string
secret
string
created_at
string
| date-time
Timestamp when the app config was created.
inventory
object (AffiliateInventoryConfig)
Show
article_assignment
object (AffiliateInventoryArticleAssignmentConfig)
Show
post_order_reassignment
boolean
payment
object (AffiliateInventoryPaymentConfig)
Show
source
string
mode_of_payment
string
inventory
object (AffiliateInventoryStoreConfig)
Show
store
object
Fulfilling store information related to the shipment.
order
object (AffiliateInventoryOrderConfig)
Show
force_reassignment
boolean
logistics
object (AffiliateInventoryLogisticsConfig)
Show
dp_assignment
boolean
app_company_id
integer
Nullable
A unique identifier for the company associated with the affiliate app, used for tracking and managing affiliate relationships.
affiliate_id
string
Nullable
The unique identifier for the affiliate.
affiliate_store_id
string
The unique identifier for the affiliate's store.
affiliate_bag_id
string
The unique identifier for the affiliate's bag.
id
string
Nullable
The unique identifier for the affiliate.
is_active
boolean
This flag denotes whether the shipment is active or not.
channel
object (ShipmentListingChannel)
Show
channel_shipment_id
string
Nullable
A unique identifier for the shipment associated with a specific channel, facilitating tracking and management.
is_affiliate
boolean
Nullable
Indicates whether the shipment is associated with an affiliate program, which may affect processing and fulfillment.
logo
string
Nullable
A URL or path to the logo of the shipment channel, used for branding and identification purposes.
name
string
Nullable
The name of the shipment channel, providing a human-readable reference for the channel through which the shipment is processed.
previous_shipment_id
string
Nullable
The ID of any previous shipment related to this order.
forward_end_shipment_id
string
Nullable
The forward_end_shipment_id represents the shipment ID of the original forward journey shipment. When a shipment is transitioned to a return journey, the original shipment ID from the forward journey is recorded in the forward_end_shipment_id field of the return journey shipment. Even if the return shipment is later split into multiple shipments, each of these shipments will retain the same forward_end_shipment_id value that was assigned during the initial return journey initiation. This ensures that all return shipments can be traced back to the original forward journey shipment.
lock_status
boolean
Nullable
Indicates whether the shipment is currently locked for processing (true) or not (false).
invoice_id
string
Nullable
The ID of the invoice associated with the shipment.
payment_methods
object
Nullable
This field stores a collection of payment method objects used in a transaction. Each key within this object represents a unique payment method code (e.g., "COD" for Cash On Delivery), and its value is an object containing detailed information about that payment method. This includes metadata such as logos, payment IDs, and merchant codes, as well as transaction-specific details like the payment mode, name, amount, and entities responsible for refunds and collections. The structure is designed to accommodate any number of payment methods, providing flexibility and comprehensive insights into each transaction's payment aspect.
payment_info
array of object
Nullable
An array of payment information items related to the shipment, detailing transaction specifics.
status_created_at
string
| date-time
Date time in UTC timezone as per ISO format.
status_created_ts
string
The timestamp indicating when the current status was logged, usually in ISO 8601 format.
display_name
string
Nullable
A user-friendly name or identifier for the shipment, useful for display purposes.
bags
array of object (BagUnit)
An array of bags included in the shipment.
Show
bag_type
string
Nullable
Specifies the type or category of the bag.
Enum
gst
object (GSTDetailsData)
Show
cgst_tax_percentage
number
Nullable
The percentage of Central Goods and Services Tax (CGST) applicable on the goods or services.
gstin_code
string
Nullable
A GST Number (Goods and Services Tax Identification Number, often abbreviated as GSTIN) is a unique identifier assigned to a business or individual registered under the Goods and Services Tax (GST) system in countries like India. The GST number is essential for businesses to comply with tax regulations and for the government to track tax payments and returns.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
gst_fee
number
The total GST fee charged on the goods or services.
igst_tax_percentage
number
Nullable
The percentage of Integrated Goods and Services Tax (IGST) applicable for inter-state transactions.
gst_tax_percentage
number
Nullable
The overall GST tax percentage applicable to the goods or services.
hsn_code_id
string
Nullable
Unique identifier for the Harmonized System of Nomenclature (HSN) code used to classify goods.
igst_gst_fee
number
Nullable
The GST fee applicable for IGST, usually for inter-state transactions.
is_default_hsn_code
boolean
Nullable
Indicates whether this HSN code is the default classification for the goods.
sgst_gst_fee
number
Nullable
The GST fee applicable for State Goods and Services Tax (SGST).
tax_collected_at_source
number
Tax amount collected at the source of income or transaction, often for compliance and revenue tracking.
brand_calculated_amount
number
Amount calculated by the brand, potentially reflecting costs, fees, or pricing structures.
cgst_gst_fee
number
Nullable
The GST fee applicable for CGST.
gst_tag
string
Nullable
A tag or label used to denote GST-related attributes or classifications.
sgst_tax_percentage
number
Nullable
The percentage of State Goods and Services Tax (SGST) applicable on the goods or services.
hsn_code
string
Nullable
The HSN Code (Harmonized System of Nomenclature Code) is an internationally standardized system for classifying goods. It is used in trade and commerce to identify products and services uniformly across different countries and industries. The system was developed by the World Customs Organization (WCO) and is widely used in customs processes and tax systems.
financial_breakup
array of object (FinancialBreakup)
Show
refund_credit
number
The amount of refund credits applicable for the transaction.
amount_paid_roundoff
integer
Nullable
Total amount paid, rounded off to the nearest integer for billing purposes.
price_effective
number
The effective price after applying discounts and before any taxes.
promotion_effective_discount
number
The amount of discount applied from promotional offers.
transfer_price
number
The fixed selling price applicable for payouts by the brand.
coupon_effective_discount
number
The discount applied through a coupon code, if applicable.
gst_fee
number
Total Goods and Services Tax (GST) fee charged on the goods or services.
tax_collected_at_source
number
Nullable
Tax amount collected at the source of income or transaction.
brand_calculated_amount
number
Amount calculated by the brand, possibly reflecting various costs or fees.
delivery_charge
number
Fee applicable for the delivery of the goods.
gst_tag
string
A tag used to denote GST-related attributes or classifications.
hsn_code
string
The HSN Code (Harmonized System of Nomenclature Code) is an internationally standardized system for classifying goods, used in trade and commerce for uniform identification across different countries.
cashback
number
The cashback amount provided to the customer, if applicable.
item_name
string
The name or description of the item related to the financial breakup.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
cashback_applied
number
The effective cashback value that has been applied to the transaction.
cod_charges
number
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
The indicated price or value assigned to an item before any discounts or adjustments.
size
string
The size of the item, if applicable.
amount_paid
number
Total amount paid by the customer for the transaction.
coupon_value
number
The effective value of the coupon used in the transaction.
discount
number
Total amount discounted from the original price of the goods.
fynd_credits
number
Credits provided by Fynd to the customer, possibly as part of a rewards program.
gst_tax_percentage
number
The percentage of GST applicable on the goods or services.
amount_to_be_collected
number
Amount to be collected in case of multiple modes of payments.
identifiers
object (Identifier)
Show
alu
string
Nullable
The ALU (Article Level Unit) code used to identify the item at a detailed level, often specific to certain retail or distribution systems.
ean
string
Nullable
The European Article Number (EAN) is a unique identifier for products, primarily used in retail and logistics. It helps in tracking and managing inventory across various platforms.
sku_code
string
Nullable
The Stock Keeping Unit (SKU) code of the item - uniquely identifies each distinct product. SKUs are used to track inventory levels, facilitate accurate stocktaking, and streamline order fulfillment processes. This code is essential for inventory management, allowing for the differentiation between products based on attributes such as price, color, and size.
upc
string
Nullable
The Universal Product Code (UPC) is a barcode symbol used for tracking trade items in stores. It is widely used in North America and helps in identifying products quickly during point-of-sale transactions.
isbn
string
Nullable
The International Standard Book Number (ISBN) is a unique identifier for books, allowing for easier management and tracking of book inventories in retail and library systems.
total_units
integer
The total number of units involved in the transaction.
added_to_fynd_cash
boolean
Indicates whether the amount has been added to Fynd cash for future use.
taxes
array of object (TaxComponent)
Applied Tax Components
Show
Represents a detailed breakdown of a specific tax component applied to a transaction or item.
This schema provides information about the type of tax, the rate at which it is applied,
the calculated tax amount, and the base amount on which the tax is computed.
name
string
The name or type of the tax component (e.g., GST, VAT, Service Tax).
This helps in identifying the specific tax being applied to the transaction or item.
rate
number
| float
The percentage rate at which the tax is applied to the taxable amount.
This value is typically represented as a decimal (e.g., 0.18 for 18% tax).
tax_amount
number
| float
The total monetary value of the tax calculated for this component.
This is derived by applying the tax rate to the taxable amount.
taxable_amount
number
| float
The base amount on which the tax is calculated, excluding the tax itself.
This represents the value of goods or services before tax is applied.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
bag_expiry_date
string
| date-time
Nullable
Indicates the date and time when the contents of a bag, or the bag itself, are no longer considered valid or safe for use. This is particularly relevant in contexts where the bag contains perishable goods, sensitive materials, or items with a limited shelf life
bag_status
array of object (BagStatusHistory)
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
It is a type being used to represent the journey of shipment through the performed status transition. Forward Journey: The forward journey encompasses all the stages of shipping, including order placement, packing, dispatch, in-transit updates, and delivery. Return Journey: Contrary to the forward journey, the return journey involves the process of sending items back from the customer to the original sender or a designated return facility.
Enum
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
current_operational_status
object (BagStatusHistory)
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
It is a type being used to represent the journey of shipment through the performed status transition. Forward Journey: The forward journey encompasses all the stages of shipping, including order placement, packing, dispatch, in-transit updates, and delivery. Return Journey: Contrary to the forward journey, the return journey involves the process of sending items back from the customer to the original sender or a designated return facility.
Enum
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
article
object (Article)
Show
seller_identifier
string
Unique identifier assigned by the seller to the article, used for inventory management.
uid
string
A unique identifier for the article within the system.
set
object
Nullable
Represents the data related to combinations of articles that, while being the same product, vary by size, color, or other distinguishing features.
dimensions
object (Dimensions)
Show
height
number
Nullable
The height measurement of the object, typically representing the vertical dimension.
width
number
Nullable
The width measurement of the object, indicating the horizontal dimension.
is_default
boolean
Nullable
A flag indicating whether these dimensions are the default measurements for the object.
unit
string
Nullable
The unit of measurement used for the dimensions (e.g., centimeters, inches).
length
number
Nullable
The length measurement of the object, representing the longest dimension.
currency
object
Nullable
Currency in which the transaction amount associated with the article is specified.
esp_modified
boolean
Nullable
Indicates whether the article has been modified by the ESP (e-commerce service provider).
return_config
object (ReturnConfig)
Nullable
Configuration related to the return policy for the article.
Show
returnable
boolean
Nullable
Indicates whether the article is eligible for return, allowing customers to send it back under specified conditions.
time
number
Nullable
The time frame within which the return must be initiated, typically measured in days.
unit
string
Nullable
The unit of time for the return period (e.g., days, weeks).
code
string
Nullable
Internal code or identifier for the article, used for reference.
weight
object (Weight)
Show
is_default
boolean
Nullable
Indicates whether this weight value is the default weight used for the article.
shipping
integer
Nullable
The weight of the article specifically for shipping purposes, usually measured in grams or kilograms.
unit
string
Nullable
The unit of measurement for the weight (e.g., grams, kilograms, pounds).
_id
string
The unique identifier for the article within the database.
identifiers
object
Details of identifiers associated with the article, including SKU codes and other relevant identifiers.
raw_meta
string
Nullable
Raw metadata associated with the article, providing additional context or information.
size
string
Size of the article, which may vary for clothing, accessories, etc.
is_set
boolean
Nullable
Indicates whether the article is part of a set or collection.
tags
array of string
Nullable
Tags associated with the article for categorization and search optimization.
_custom_json
object
A custom JSON object containing additional details or configurations specific to the article.
brand
object (ShipmentListingBrand)
Show
logo
string
Nullable
URL or path to the logo image of the brand associated with the shipment.
created_on
string
| date-time
Nullable
Timestamp indicating when the brand of the shipment was created, formatted as date-time.
name
string
Nullable
The name of the brand linked to the shipment.
logo_base64
string
Nullable
Base64 encoded string of the brand's logo image, allowing for direct embedding in documents or applications.
affiliate_bag_details
object (AffiliateBagDetails)
Show
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
affiliate_order_id
string
Unique identifier for the affiliate order associated with the bag.
employee_discount
number
Nullable
Discount percentage or amount applicable to employees for this order.
affiliate_bag_id
string
Unique identifier for the affiliate bag, used for tracking and reference.
loyalty_discount
number
| float
Discount amount applied based on customer loyalty, if applicable.
item
object (PlatformItem)
Show
id
integer
Nullable
Unique identifier for the platform item.
attributes
object (PlatformArticleAttributes)
Show
currency
string
Nullable
The currency in which the price of the article is specified.
brand_id
integer
Nullable
Identifier for the brand associated with the item.
slug_key
string
Nullable
A user-friendly string that represents the item, often used in URLs.
l3_category
integer
Nullable
Represents the product's classification at the third level in the e-commerce platform's category hierarchy, using an integer identifier.
l3_category_name
string
Nullable
Name of the third-level category under which the product is listed.
last_updated_at
string
| date-time
Nullable
Timestamp when any aspect of the associated record was modified, formatted as date-time.
name
string
Nullable
The name of the product item.
l2_category
array of string
Nullable
Represents the second level of categorization for items, helping customers narrow down their search.
brand
string
Nullable
Name of the brand associated with the item.
image
array of string
Nullable
Array of image URLs representing the item.
code
string
Nullable
Unique code for the item, often used for inventory management.
l1_category
array of string
Nullable
Represents the highest or top-tier level of categorization for the product.
size
string
Nullable
Size specification of the product, if applicable.
can_cancel
boolean
Nullable
Indicates whether the item can be canceled after order placement.
can_return
boolean
Nullable
Indicates whether the item is eligible for return.
branch_url
string
Nullable
URL linking to a specific branch or store where the item is available.
meta
object
Nullable
Meta data containing additional, dynamic information about the item.
color
string
Nullable
Color specification of the product, if applicable.
department_id
integer
Nullable
Identifier for the department associated with the product.
images
array of string
Nullable
Array of image URLs representing different views or angles of the item.
tags
array of string
Nullable
Custom labels or keywords associated with the item for categorization, filtering, or business logic purposes.
reasons
array of object
Nullable
A collection of reasons associated with the bag, which could pertain to returns, cancellations, or other relevant contexts.
product_quantity
integer
The total quantity of products contained within the bag.
can_return
boolean
Nullable
Indicates whether the items in the bag are eligible for return.
display_name
string
Nullable
A user-friendly name or label for the bag, which may be displayed in interfaces.
can_cancel
boolean
Nullable
Indicates whether the bag or its contents can be canceled.
size
string
Nullable
Specifies the size of the bag, which may be relevant for packaging or shipping considerations.
line_number
integer
Nullable
Represents the line number in an order or transaction associated with the bag.
meta
object
Nullable
Meta data of the bag contains additional, potentially dynamic information about the bag.
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
ordering_currency_prices
object (OrderingCurrencyPrices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc in currency used by customer.
refund_credit
number
Nullable
Amount of refund credits applicable to the customer's account for returned items or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid by the customer, rounded off to the nearest integer for ease of processing.
price_effective
number
Nullable
Final effective price of the product after applying discounts to the marked retail price (MRP).
promotion_effective_discount
number
Nullable
Total discount amount applied through promotional offers specific to the customer's purchase.
pm_price_split
number
Nullable
Updated selling price of the product after any repricing adjustments made before the sale.
refund_amount
number
Nullable
Amount that will be refunded to the customer in case of order cancellation or product return.
transfer_price
number
Nullable
Fixed price set for payouts by the brand, representing the cost to the retailer or affiliate.
coupon_effective_discount
number
Nullable
Discount value realized through the use of a coupon code applied at the time of purchase.
tax_collected_at_source
number
Nullable
Total tax amount that is collected at the point of sale, often applicable for tax regulations.
brand_calculated_amount
number
Nullable
Amount calculated by the brand after applying any relevant coupons and promotions to the base price.
delivery_charge
number
Nullable
Cost charged for the delivery service, as determined by the delivery partner handling the shipment.
cashback
number
Nullable
Points or monetary value returned to the customer as a reward for their purchase, which can be used for future transactions.
value_of_good
number
Nullable
Net selling price of the product after excluding the GST (Goods and Services Tax) amount from the total.
cashback_applied
number
Nullable
Total cashback value that has been applied to the customer's account or to the current transaction.
cod_charges
number
Nullable
Additional fee charged for orders placed via cash on delivery (COD) payment method.
price_marked
number
Nullable
The original price indicated for the product before any discounts or promotions are applied.
amount_paid
number
Nullable
The total amount the customer has paid for their order, including all applicable charges and discounts.
coupon_value
number
Nullable
The specific value of the coupon used in the transaction, reflecting its impact on the total price.
discount
number
Nullable
Total amount discounted from the original price of the product, reflecting savings for the customer.
fynd_credits
number
Nullable
Credits provided by Fynd, which can be used for discounts on future purchases.
gift_price
number
Nullable
Monetary value assigned to a gift card purchased by the customer, usable for future transactions.
amount_to_be_collected
number
Nullable
Amount to be collected from the customer when multiple payment methods are utilized for a single order.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
dates
object (Dates)
Show
delivery_date
string
| date-time
Nullable
Represents the scheduled date and time for the delivery of the entity.
order_created
string
Nullable
current_status
object (BagStatusHistory)
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
It is a type being used to represent the journey of shipment through the performed status transition. Forward Journey: The forward journey encompasses all the stages of shipping, including order placement, packing, dispatch, in-transit updates, and delivery. Return Journey: Contrary to the forward journey, the return journey involves the process of sending items back from the customer to the original sender or a designated return facility.
Enum
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
bag_id
integer
Unique identifier for the bag.
entity_type
string
Nullable
Specifies the type of entity.
Enum
status
object (BagReturnableCancelableStatus)
Show
is_returnable
boolean
Indicates whether the bag can be returned by the customer.
is_active
boolean
Specifies if the current status of the bag is active, affecting its eligibility for return or cancellation.
can_be_cancelled
boolean
Indicates if the bag order can be cancelled by the customer.
enable_tracking
boolean
Indicates whether tracking is enabled for the bag, allowing customers to monitor its status.
is_customer_return_allowed
boolean
Specifies if the customer is permitted to return the bag, based on the return policy.
fulfilling_store
object (ShipmentItemFulFillingStore)
Show
phone
string
Nullable
Contact number for the fulfilling store, allowing customers to reach out for inquiries or assistance.
brand_store_tags
array of string
Nullable
Tags associated with the brand store, providing additional categorization or identification of the store's attributes.
pincode
string
Nullable
Postal code for the fulfilling store's location, essential for identifying the specific area and ensuring accurate deliveries.
meta
object
Nullable
Meta data of the fulfilling store that contains additional, potentially dynamic information about the fulfilling store.
address
string
Nullable
Comprehensive address details of the fulfilling store, including all necessary components for locating the store.
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
Address1 compiles all into a single formatted string.
The address is formed by the template provided and whichever keys are present in the template are
populated as is from store address fields.
Template Example: {address} {address2}_{area} {state}_{country},
display_address
string
Nullable
A user-friendly formatted version of the store's address for display purposes, making it easier for customers to read.
location_type
string
Nullable
Type of location of the fulfilling store.
Enum
id
integer
Unique identifier for the fulfilling store in the database.
code
string
A specific code assigned to the store, often used for internal tracking or categorization purposes.
store_email
string
Nullable
Email address for the fulfilling store, allowing for electronic communication and inquiries.
name
string
Nullable
The name of the fulfilling store, which helps customers identify the store.
state
string
Nullable
The state where the fulfilling store is located, important for regional identification.
city
string
Nullable
The city where the fulfilling store is situated, providing more specific location details.
tags
array of string
Nullable
Additional tags associated with the store, used for categorization and filtering purposes.
meta
object
Meta data of the item contains additional, potentially dynamic information about the item.
payment_mode
string
Nullable
The mode of payment used for the shipment.
can_process
boolean
Nullable
Indicates whether the shipment can currently be processed (true) or not (false).
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
ordering_currency_prices
object (OrderingCurrencyPrices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc in currency used by customer.
refund_credit
number
Nullable
Amount of refund credits applicable to the customer's account for returned items or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid by the customer, rounded off to the nearest integer for ease of processing.
price_effective
number
Nullable
Final effective price of the product after applying discounts to the marked retail price (MRP).
promotion_effective_discount
number
Nullable
Total discount amount applied through promotional offers specific to the customer's purchase.
pm_price_split
number
Nullable
Updated selling price of the product after any repricing adjustments made before the sale.
refund_amount
number
Nullable
Amount that will be refunded to the customer in case of order cancellation or product return.
transfer_price
number
Nullable
Fixed price set for payouts by the brand, representing the cost to the retailer or affiliate.
coupon_effective_discount
number
Nullable
Discount value realized through the use of a coupon code applied at the time of purchase.
tax_collected_at_source
number
Nullable
Total tax amount that is collected at the point of sale, often applicable for tax regulations.
brand_calculated_amount
number
Nullable
Amount calculated by the brand after applying any relevant coupons and promotions to the base price.
delivery_charge
number
Nullable
Cost charged for the delivery service, as determined by the delivery partner handling the shipment.
cashback
number
Nullable
Points or monetary value returned to the customer as a reward for their purchase, which can be used for future transactions.
value_of_good
number
Nullable
Net selling price of the product after excluding the GST (Goods and Services Tax) amount from the total.
cashback_applied
number
Nullable
Total cashback value that has been applied to the customer's account or to the current transaction.
cod_charges
number
Nullable
Additional fee charged for orders placed via cash on delivery (COD) payment method.
price_marked
number
Nullable
The original price indicated for the product before any discounts or promotions are applied.
amount_paid
number
Nullable
The total amount the customer has paid for their order, including all applicable charges and discounts.
coupon_value
number
Nullable
The specific value of the coupon used in the transaction, reflecting its impact on the total price.
discount
number
Nullable
Total amount discounted from the original price of the product, reflecting savings for the customer.
fynd_credits
number
Nullable
Credits provided by Fynd, which can be used for discounts on future purchases.
gift_price
number
Nullable
Monetary value assigned to a gift card purchased by the customer, usable for future transactions.
amount_to_be_collected
number
Nullable
Amount to be collected from the customer when multiple payment methods are utilized for a single order.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
order_id
string
The unique identifier of the order for the shipment.
ordering_channnel
string
Nullable
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
shipment_id
string
Nullable
The unique identifier for the shipment itself.
customer_note
string
Nullable
Any special notes or instructions provided by the customer related to the shipment.
total_bags
integer
The total number of bags in the shipment.
shipment_created_at
string
| date-time
Timestamp of the shipment created.
mode_of_payment
string
The method of payment used to create the order.
shipment_created_ts
string
The timestamp indicating when the shipment was created.
currency
object (Currency)
Show
currency_code
string
This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
currency_symbol
string
The symbol representing the currency.
currency_info
object (CurrencyInfo)
Show
ordering_currency
object (OrderingCurrency)
Show
currency_code
string
This specifies the currency code for all amounts.
currency_name
string
The full name of the currency.
currency_symbol
string
The symbol representing the currency.
currency_sub_unit
string
The sub-unit of the currency
conversion_rate
object (ConversionRate)
Show
base
string
The base currency code, example 'INR' for Indian Rupee, against which all conversion rates are calculated. Follows the ISO 4217 standard.This includes the currency's name, its conversion rate relative to the base currency ('value'), the currency symbol, and any sub-unit of the currency. This setup not only facilitates currency conversion but also enriches the data with useful currency descriptors, enhancing financial operations and analyses.
rates
object
An object , where each key is a currency code and its value is an object containing detailed information
about that currency. This includes the currency's name, its conversion rate relative to the base currency
('value'), the currency symbol, and any sub-unit of the currency. This setup not only facilitates currency
conversion but also enriches the data with useful currency descriptors.
is_lapa_enabled
boolean
Flag to show NDR actions based on LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true, else false.
logistics_meta
object
An object storing detailed logistics-related information, including courier partner details and other relevant metadata.
fulfillment_option
object (FulfillmentOption)
Show
name
string
slug
string
type
string
is_default
boolean
lane
string
Nullable
The lane associated with the shipment.
page
object (Page)
Show
An object representing a page with pagination details.
item_total
integer
| int32
The total number of all items across all pages.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, can be 'cursor' or 'number'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Response
List sales channel shipments
getApplicationShipments
Parameters
company_idpath
string
Required
Unique identifier of a company on the platform.
application_idpath
string
Required
A unique identifier for the application on the platform
shipment_idpath
string
Required
The unique identifier for the shipment
GET
Response
200
Successful response containing the tracking details of the specified shipment. This response includes status updates, location details, account name, AWB number, and additional metadata. The example provided below demonstrates the structure of the response payload.
Hide
meta
object
Meta data of the shipment contains additional, potentially dynamic information about the shipment.
results
array of object (PlatformTrack)
A list of tracking details at various status.
Show
last_location_recieved_at
string
Nullable
The current geographic location of the courier partner.
meta
object
A field to store additional metadata related to the courier partner's operations or the shipment.
raw_status
string
The current status of the shipment as updated by the courier partner.
updated_at
string
| date-time
Human readable timestamp when the status was last updated by the courier partner.
updated_time
string
| date-time
The timestamp when the status was last updated by the courier partner.
awb
string
The Air Waybill (AWB) number associated with the shipment, used for tracking the parcel in transit.
shipment_type
string
Indicates the type of journey the shipment.
Enum
status
string
The operational status of the shipment.
reason
string
Nullable
Any additional remarks or comments from the courier partner regarding the shipment.
account_name
string
The name of the courier partner responsible for the shipment.
Response
Track shipment
trackShipmentPlatform
Get reasons to perform full or partial cancellation of a shipment
Parameters
company_idpath
integer
Required
application_idpath
string
Required
actionpath
string
Required
GET
Response
200
Success.
Hide
reasons
array of object (ShipmentResponseReasons)
Show
reason_id
integer
reason
string
message
string
success
boolean
Examples
Parameters
company_id:
1
application_id:
"value"
action:
"value"
Response