Order
Handles all platform order and shipment api(s)
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
# Get all questions of that cluster
GET
# Retrieve rule lane configurations
POST
# Create a new rule
GET
# Get a specific rule by ID
PUT
# Update a specific rule by ID
DEL
# Delete a specific rule by ID
POST
# Update the position of a rule
GET
# Get available rule parameters
POST
# Get a list of rules
GET
# Retrieve Reasons for Cancellation and Return journey
GET
# Get cross selling platform shipments
GET
# Track shipment
GET
# Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
Parameters
company_id
string
Required
application_id
string
Required
page_no
integer
Default Value : 1
page_size
integer
Default Value : 10
q
string
To search questions using query
Default Value : None
is_active
boolean
To get active questions
Default Value : None
Response
200
400
Successful response
Properties
page
object
Properties
type
string
current
integer
size
integer
item_total
integer
page_size
integer
has_previous
boolean
has_next
boolean
items
array of object
Array of Properties
id
integer
display_name
string
Nullable
slug
string
Nullable
is_active
boolean
Nullable
position
integer
Nullable
created_at
string
Nullable
updated_at
string
Nullable
created_by
string
Nullable
updated_by
string
Nullable
success
boolean
Nullable
error
object (QuestionErrorResponseSchema)
QuestionErrorResponseSchema
type
string
Nullable
value
string
Nullable
message
object
Nullable
Examples
Parameters
company_id:
"2"
application_id:
"6573205f9217394923560aae"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
application_id
string
Required
search_value
string
Response
200
Successful response
LaneRuleConfigSchema
super_lanes
array of object (SuperLaneItem)
Array of SuperLaneItem
text
string
value
string
options
array of object (OptionItem)
List of shipment IDs for which invoice need to be generated.
Array of OptionItem
text
string
value
string
total_items
integer
total_items
integer
Examples
Parameters
company_id:
"2"
application_id:
"6573205f9217394923560aae"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
application_id
string
Required
Request body
flow_type
string
Required
name
string
Required
description
string
entity_type
string
Required
value
string
Required
channel
string
Required
rule_type
string
Required
is_deleted
boolean
Required
restrict_forward_serviceability
boolean
conditions
array of object (Condition)
Required
Array of Condition
variable
string
Required
operation
string
Required
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
meta
object (RuleMeta)
Required
RuleMeta
department
object (Department)
Department
id
string
display_name
string
l3
object (L3)
L3
id
string
display_name
string
restrict_forward_serviceability
boolean
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
qc_enabled
boolean
Required
is_active
boolean
Required
actions
object (RuleAction)
Required
RuleAction
reasons
array of object (Reason)
Array of Reason
id
integer
display_name
string
Required
remark_required
boolean
show_text_area
boolean
Nullable
reasons
array of object (Reason)
Array of Reason
qc_type
array of string
Required
question_set
array of object (QuestionSet)
Required
Array of QuestionSet
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
Required
is_active
boolean
Required
is_deleted
boolean
Indicates whether reason is deleted
Response
200
400
Successful response
RuleSuccessResponseSchema
id
integer
success
boolean
error
object (RuleError)
RuleError
type
string
Nullable
value
string
Nullable
message
string
Nullable
Examples
Parameters
company_id:
"2"
application_id:
"6573205f9217394923560aae"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
application_id
string
Required
rule_id
string
Required
Response
200
400
Successful response
RuleResponseSchema
id
integer
items
object (RuleItem)
RuleItem
id
string
entity_type
string
value
string
Nullable
channel
string
actions
object (RuleAction)
RuleAction
reasons
array of object (Reason)
Array of Reason
id
integer
display_name
string
remark_required
boolean
show_text_area
boolean
Nullable
reasons
array of object (Reason)
Array of Reason
qc_type
array of string
question_set
array of object (QuestionSet)
Array of QuestionSet
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
is_active
boolean
is_deleted
boolean
Indicates whether reason is deleted
qc_enabled
boolean
is_deleted
boolean
restrict_forward_serviceability
boolean
conditions
array of object (Condition)
Array of Condition
variable
string
operation
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
meta
object (RuleMeta)
RuleMeta
department
object (Department)
Department
id
string
display_name
string
l3
object (L3)
L3
id
string
display_name
string
restrict_forward_serviceability
boolean
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
rule_type
string
is_active
boolean
name
string
description
string
flow_type
string
position
integer
success
boolean
Indicates whether the API call was successful (true) or not (false).
error
object (RuleError)
RuleError
type
string
Nullable
value
string
Nullable
message
string
Nullable
Examples
Parameters
company_id:
"2"
application_id:
"6573205f9217394923560aae"
rule_id:
"102"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
application_id
string
Required
rule_id
string
Required
Request body
flow_type
string
Required
name
string
Required
description
string
entity_type
string
Required
value
string
Required
channel
string
Required
rule_type
string
Required
is_deleted
boolean
Required
position
integer
Required
restrict_forward_serviceability
boolean
Required
conditions
array of object (Condition)
Required
Array of Condition
variable
string
Required
operation
string
Required
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
meta
object (RuleMeta)
Required
RuleMeta
department
object (Department)
Department
id
string
display_name
string
l3
object (L3)
L3
id
string
display_name
string
restrict_forward_serviceability
boolean
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
qc_enabled
boolean
Required
is_active
boolean
Required
actions
object (RuleAction)
Required
RuleAction
reasons
array of object (Reason)
Array of Reason
id
integer
display_name
string
Required
remark_required
boolean
show_text_area
boolean
Nullable
reasons
array of object (Reason)
Array of Reason
qc_type
array of string
Required
question_set
array of object (QuestionSet)
Required
Array of QuestionSet
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
Required
is_active
boolean
Required
is_deleted
boolean
Indicates whether reason is deleted
Response
200
400
Successful response
RuleSuccessResponseSchema
id
integer
success
boolean
error
object (RuleError)
RuleError
type
string
Nullable
value
string
Nullable
message
string
Nullable
Examples
Parameters
company_id:
"2"
application_id:
"6573205f9217394923560aae"
rule_id:
"102"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
string
Required
application_id
string
Required
rule_id
string
Required
Response
200
400
Successful response
RuleSuccessResponseSchema
id
integer
success
boolean
error
object (RuleError)
RuleError
type
string
Nullable
value
string
Nullable
message
string
Nullable
Examples
Parameters
company_id:
"2"
application_id:
"6573205f9217394923560aae"
rule_id:
"102"
Was this section helpful?
DEL
Response
Parameters
company_id
string
Required
application_id
string
Required
Request body
rule_id
integer
Required
page_no
integer
Required
page_size
integer
Required
position
integer
Required
flow_type
string
Required
Response
200
400
Successful response
RuleListResponseSchema
page
object (PageInfo)
PageInfo
type
string
current
integer
size
integer
item_total
integer
has_previous
boolean
has_next
boolean
page_size
integer
items
array of object (RuleItem)
Array of RuleItem
id
string
entity_type
string
value
string
Nullable
channel
string
actions
object (RuleAction)
RuleAction
reasons
array of object (Reason)
Array of Reason
id
integer
display_name
string
remark_required
boolean
show_text_area
boolean
Nullable
reasons
array of object (Reason)
Array of Reason
qc_type
array of string
question_set
array of object (QuestionSet)
Array of QuestionSet
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
is_active
boolean
is_deleted
boolean
Indicates whether reason is deleted
qc_enabled
boolean
is_deleted
boolean
restrict_forward_serviceability
boolean
conditions
array of object (Condition)
Array of Condition
variable
string
operation
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
meta
object (RuleMeta)
RuleMeta
department
object (Department)
Department
id
string
display_name
string
l3
object (L3)
L3
id
string
display_name
string
restrict_forward_serviceability
boolean
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
rule_type
string
is_active
boolean
name
string
description
string
flow_type
string
position
integer
success
boolean
error
object (RuleError)
RuleError
type
string
Nullable
value
string
Nullable
message
string
Nullable
Examples
Parameters
company_id:
"2"
application_id:
"6573205f9217394923560aae"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
application_id
string
Required
Response
200
Successful response
RuleParametersResponseSchema
response
array of object (ParameterResponseSchema)
Array of ParameterResponseSchema
text
string
value
string
Examples
Parameters
company_id:
"2"
application_id:
"6573205f9217394923560aae"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
application_id
string
Required
Request body
page_size
integer
page_no
integer
flow_type
string
lane_type
string
Response
200
400
Successful response
RuleListResponseSchema
page
object (PageInfo)
PageInfo
type
string
current
integer
size
integer
item_total
integer
has_previous
boolean
has_next
boolean
page_size
integer
items
array of object (RuleItem)
Array of RuleItem
id
string
entity_type
string
value
string
Nullable
channel
string
actions
object (RuleAction)
RuleAction
reasons
array of object (Reason)
Array of Reason
id
integer
display_name
string
remark_required
boolean
show_text_area
boolean
Nullable
reasons
array of object (Reason)
Array of Reason
qc_type
array of string
question_set
array of object (QuestionSet)
Array of QuestionSet
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
is_active
boolean
is_deleted
boolean
Indicates whether reason is deleted
qc_enabled
boolean
is_deleted
boolean
restrict_forward_serviceability
boolean
conditions
array of object (Condition)
Array of Condition
variable
string
operation
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
meta
object (RuleMeta)
RuleMeta
department
object (Department)
Department
id
string
display_name
string
l3
object (L3)
L3
id
string
display_name
string
restrict_forward_serviceability
boolean
Nullable
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
rule_type
string
is_active
boolean
name
string
description
string
flow_type
string
position
integer
success
boolean
error
object (RuleError)
RuleError
type
string
Nullable
value
string
Nullable
message
string
Nullable
Examples
Parameters
company_id:
"1"
application_id:
"6573205f9217394923560aae"
body:
body
Was this section helpful?
POST
Response
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_id
integer
Required
Unique identifier of a company on the platform.
application_id
string
Required
A unique identifier for the application on the platform
shipment_id
string
Required
The unique identifier for the shipment
line_number
integer
Required
A unique identifier of the bag's line number.
bag_id
string
Required
The ID of the bag.
Response
200
404
A successful response
ShipmentBagReasons
reasons
array of object (BagReasons)
List of bag reasons for a shipment with a corresponding shipment status.
Array of BagReasons
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)
BagReasonMeta
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.
Array of QuestionSet
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.
Array of BagReasons
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:
"653f323e1271957175730e95"
shipment_id:
"16984021800861979616"
line_number:
1
bag_id:
"6393"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
Unique identifier of a company on the platform.
application_id
string
Required
A unique identifier for the application or system that is making the order request.
lane
string
Optional parameter to specify the lane for filtering results.
search_type
string
search_type refers to the field that will be used as the target for the search operation
Enum
search_id
string
Identifier used for the search operation based on the selected search type.
search_value
string
from_date
string
| date
Date time in UTC timezone as per ISO format.
to_date
string
| date
Date time in UTC timezone as per ISO format.
dp_ids
string
Comma-separated list of delivery partner IDs to filter results.
ordering_company_id
string
ID of the company placing the order, used for filtering results.
stores
string
Comma-separated list of store IDs to filter results.
sales_channel
string
The sales channel to filter results.
request_by_ext
string
Identifier for external requests.
page_no
integer
The page number for pagination of results.
page_size
integer
The number of results to return per page for pagination.
customer_id
string
ID of the customer to filter results related to specific customer.
is_priority_sort
boolean
Flag to determine if results should be sorted by priority. Defaults to true.
Default Value : true
exclude_locked_shipments
boolean
Flag to exclude shipments that are currently locked from the results.
Default Value : true
Response
200
We are processing the report!
ShipmentInternalPlatformViewResponseSchema
total_count
integer
Nullable
The total number of shipments matching the query criteria.
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)
Nullable
An array of shipment items returned as part of the response.
Array of ShipmentItem
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
Nullable
Order created date
shipment_status
object (ShipmentStatus)
ShipmentStatus
current_shipment_status
string
Nullable
Current shipment status; it can be financial, logistics or operational
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.
status_created_ts
string
Nullable
Shipment status created date timestamp
status
string
This key denotes the status of the shipment, providing a clear indication of its current processing stage.
updated_ts
string
Nullable
A general timestamp indicating when the status was updated, useful for processing and tracking.
user
object (UserDataInfo)
UserDataInfo
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
User Object ID assigned within the system
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
string
Nullable
Additional metadata related to the user.
is_anonymous_user
boolean
Nullable
Indicates whether the user is an anonymous user (true) or registered (false).
avis_user_id
string
Nullable
Avis user id
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.
delivery_address
object (Address)
Nullable
Address
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
integer
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
integer
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
string
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
store_address_json
object
id
number
location_type
string
Enum
company_id
number
store_email
string
billing_address
object (Address)
Nullable
Address
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
integer
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
integer
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
string
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
store_address_json
object
id
number
location_type
string
Enum
company_id
number
store_email
string
affiliate_details
object (AffiliateDetails)
AffiliateDetails
shipment_meta
object (ShipmentMeta)
ShipmentMeta
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)
BuyerDetails
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)
Formatted
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)
DebugInfo
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)
EinvoiceInfo
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)
Dimensions
height
number
Nullable
The height of the product
width
number
Nullable
The width of the product
is_default
boolean
Nullable
Whether the dimension is the default one or not
unit
string
Nullable
The unit of dimension
length
number
Nullable
The length of the product
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.
Array of ShipmentTags
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)
LockData
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)
ShipmentTimeStamp
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)
AffiliateMeta
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
Nullable
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
ReplacementDetails
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.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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)
PDFLinks
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)
AffiliateConfig
app
object (AffiliateAppConfig)
AffiliateAppConfig
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)
Array of AffiliateAppConfigMeta
value
string
name
string
owner
string
secret
string
created_at
string
| date-time
Timestamp when the app config was created.
inventory
object (AffiliateInventoryConfig)
AffiliateInventoryConfig
article_assignment
object (AffiliateInventoryArticleAssignmentConfig)
AffiliateInventoryArticleAssignmentConfig
post_order_reassignment
boolean
payment
object (AffiliateInventoryPaymentConfig)
AffiliateInventoryPaymentConfig
source
string
mode_of_payment
string
inventory
object (AffiliateInventoryStoreConfig)
AffiliateInventoryStoreConfig
store
object
Fulfilling store information related to the shipment.
order
object (AffiliateInventoryOrderConfig)
AffiliateInventoryOrderConfig
force_reassignment
boolean
logistics
object (AffiliateInventoryLogisticsConfig)
AffiliateInventoryLogisticsConfig
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.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
is_active
boolean
This flag denotes whether the shipment is active or not.
channel
object (ShipmentListingChannel)
ShipmentListingChannel
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.
Array of BagUnit
bag_type
string
Nullable
Specifies the type or category of the bag.
Enum
gst
object (GSTDetailsData)
GSTDetailsData
cgst_tax_percentage
number
Nullable
Percentage of Central Goods and Services Tax (CGST) applied to the transaction, applicable for intra-state transactions within the same state
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
Effective selling price - Product GST Amount
gst_fee
number
The fee associated with Goods and Services Tax (GST) for a product or service
igst_tax_percentage
number
Nullable
Percentage of Integrated Goods and Services Tax (IGST) applied to the transaction, applicable for inter-state transactions
gst_tax_percentage
number
Nullable
The percentage rate of GST applied to a product or service
hsn_code_id
string
Nullable
The unique identifier associated with HSN code
igst_gst_fee
number
Nullable
Amount of Integrated Goods and Services Tax (IGST) fee applied to the transaction, relevant for inter-state transactions
is_default_hsn_code
boolean
Nullable
Indicates if the HSN code is default
sgst_gst_fee
number
Nullable
Amount of State Goods and Services Tax (SGST) fee applied to the transaction, relevant for intra-state transactions within the same state
tax_collected_at_source
number
The tax amount collected at the source of income or transaction
brand_calculated_amount
number
Effective selling price - Brands additional discounts
cgst_gst_fee
number
Nullable
Amount of Central Goods and Services Tax (CGST) fee applied to the transaction, applicable for intra-state transactions within the same state
gst_tag
string
Nullable
Type of GST applied - IGST, CGST, SGST
sgst_tax_percentage
number
Nullable
Percentage of State Goods and Services Tax (SGST) applied to the transaction, applicable for intra-state transactions within the same state
hsn_code
string
Nullable
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
financial_breakup
array of object (FinancialBreakup)
Array of FinancialBreakup
refund_credit
number
Refund credits provided to the customer
amount_paid_roundoff
integer
Nullable
Amount paid rounded off
price_effective
number
MRP - Initial Seller provided discount
promotion_effective_discount
number
Effective promotion discount including promotions given by seller and Platform
transfer_price
number
article
coupon_effective_discount
number
Coupon provided by brand or seller
gst_fee
number
The fee associated with Goods and Services Tax (GST) for a product or service
tax_collected_at_source
number
Nullable
The tax amount collected at the source of income or transaction
brand_calculated_amount
number
Price Effective - Coupon Discount (Seller) - Promotion (Seller)
delivery_charge
number
The fee associated with the delivery service for transporting the item to its destination
gst_tag
string
Type of GST applied - IGST, CGST, SGST
hsn_code
string
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
cashback
number
Cashback points
item_name
string
The name of the item being referenced
value_of_good
number
Effective selling price - Product GST Amount
cashback_applied
number
Cashback applied on the order
cod_charges
number
The fee associated with the COD order
price_marked
number
The indicated price or value assigned to an item before any discounts or adjustments
size
string
The physical dimensions or specifications of the item, indicating its size or measurements
amount_paid
number
Amount paid by the customer
coupon_value
number
Stores the coupon value as shown in the cart
discount
number
The total amount discounted from the original MRP/actual price
fynd_credits
number
Credits provided by Fynd
gst_tax_percentage
number
The percentage rate of GST applied to a product or service
amount_to_be_collected
number
Amount to be collected in case of multiple modes of payments.
identifiers
object (Identifier)
Identifier
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
Total number of units of the item
added_to_fynd_cash
boolean
Flag indicating whether fynd cash has been used
refund_amount
number
tcs_percentage
number
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)
Array of BagStatusHistory
forward
boolean
Nullable
Flag to check forward
store_id
integer
Nullable
Store id associated with the bag
delivery_awb_number
string
Nullable
Airway Bill (AWB) number associated with the delivery
kafka_sync
boolean
Nullable
Flag indicating whether the bag status history update has been sync with Kafka
delivery_partner_id
integer
Nullable
Unique identifier of delivery partner
app_display_name
string
Nullable
The display name of a shipment status as it appears on the sale channels website
state_id
integer
Nullable
The unique identifier associated with the state
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
The unique identifier associated with the state
created_at
string
| date-time
Nullable
Date and time when the bag status history record was created
created_ts
string
Nullable
Timestamp indicating the exact time when the bag status history record was created
shipment_id
string
Nullable
Unique shipment no. that is auto-generated
updated_at
string
| date-time
Nullable
Date and time of the most recent update to the bag status history record
updated_ts
string
Nullable
Timestamp indicating the last time the bag status history record was updated
bag_state_mapper
object (BagStateMapper)
BagStateMapper
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
The unique identifier associated with the state
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
The unique identifier associated with the bag
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Webhook shipment status, i.e., either create or update
display_name
string
Nullable
The display name of a shipment status as it appears on the platform
app_facing
boolean
action_user
object
id
number
current_operational_status
object (BagStatusHistory)
BagStatusHistory
forward
boolean
Nullable
Flag to check forward
store_id
integer
Nullable
Store id associated with the bag
delivery_awb_number
string
Nullable
Airway Bill (AWB) number associated with the delivery
kafka_sync
boolean
Nullable
Flag indicating whether the bag status history update has been sync with Kafka
delivery_partner_id
integer
Nullable
Unique identifier of delivery partner
app_display_name
string
Nullable
The display name of a shipment status as it appears on the sale channels website
state_id
integer
Nullable
The unique identifier associated with the state
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
The unique identifier associated with the state
created_at
string
| date-time
Nullable
Date and time when the bag status history record was created
created_ts
string
Nullable
Timestamp indicating the exact time when the bag status history record was created
shipment_id
string
Nullable
Unique shipment no. that is auto-generated
updated_at
string
| date-time
Nullable
Date and time of the most recent update to the bag status history record
updated_ts
string
Nullable
Timestamp indicating the last time the bag status history record was updated
bag_state_mapper
object (BagStateMapper)
BagStateMapper
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
The unique identifier associated with the state
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
The unique identifier associated with the bag
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Webhook shipment status, i.e., either create or update
display_name
string
Nullable
The display name of a shipment status as it appears on the platform
app_facing
boolean
action_user
object
id
number
article
object (Article)
Article
child_details
object
Nullable
Contains a flexible set of key-value pairs representing detailed information about the article's child entities, including dimensions (width, height, length), weight, and unique identifiers (EAN, article code, seller identifier) for each child entity.
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)
Dimensions
height
number
Nullable
The height of the product
width
number
Nullable
The width of the product
is_default
boolean
Nullable
Whether the dimension is the default one or not
unit
string
Nullable
The unit of dimension
length
number
Nullable
The length of the product
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.
ReturnConfig
returnable
boolean
Nullable
Flag indicating whether product is returnable or not
time
number
Nullable
Number indicating number of hours or days
unit
string
Nullable
String indicating the unit of the time, eg. days, hours
code
string
Nullable
A unique alphanumeric identifier assigned to a specific article for inventory and tracking purposes
weight
object (Weight)
Weight
is_default
boolean
Nullable
Whether the weight is the default one or not
shipping
integer
Nullable
The shipping weight of the product
unit
string
Nullable
The unit of weight
_id
string
DB generated ID of the article
identifiers
object
Product identifiers
raw_meta
string
Nullable
Raw meta data of the article
size
string
The physical dimensions or specifications of the article, indicating its size or measurements
is_set
boolean
Nullable
A boolean indicating whether the article is a set
tags
array of string
Nullable
Tags associated with the article
variants
object
Nullable
This represents different variants of items such as color, shade, material, storage variants, size and more.
brand
object (ShipmentListingBrand)
ShipmentListingBrand
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)
AffiliateBagDetails
affiliate_meta
object (AffiliateMeta)
AffiliateMeta
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
Nullable
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
ReplacementDetails
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.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
Nullable
Discount amount applied based on customer loyalty, if applicable.
item
object (PlatformItem)
PlatformItem
id
integer
Nullable
Unique identifier for the platform item.
attributes
object (PlatformArticleAttributes)
PlatformArticleAttributes
currency
string
Nullable
The currency in which the price of the article is specified.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
variants
object
Nullable
This represents different variants of items such as color, shade, material, storage variants, size and more.
tags
array of string
l2_category_id
number
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)
Prices
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.
added_to_fynd_cash
boolean
gst_tax_percentage
number
tcs_percentage
number
cn_refund_amount
number
applied_emi_discount
number
applied_instant_discount
number
ordering_currency_prices
object (OrderingCurrencyPrices)
OrderingCurrencyPrices
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.
added_to_fynd_cash
number
gst_tax_percentage
number
tcs_percentage
number
cn_refund_amount
number
applied_emi_discount
number
applied_instant_discount
number
dates
object (Dates)
Dates
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)
BagStatusHistory
forward
boolean
Nullable
Flag to check forward
store_id
integer
Nullable
Store id associated with the bag
delivery_awb_number
string
Nullable
Airway Bill (AWB) number associated with the delivery
kafka_sync
boolean
Nullable
Flag indicating whether the bag status history update has been sync with Kafka
delivery_partner_id
integer
Nullable
Unique identifier of delivery partner
app_display_name
string
Nullable
The display name of a shipment status as it appears on the sale channels website
state_id
integer
Nullable
The unique identifier associated with the state
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
The unique identifier associated with the state
created_at
string
| date-time
Nullable
Date and time when the bag status history record was created
created_ts
string
Nullable
Timestamp indicating the exact time when the bag status history record was created
shipment_id
string
Nullable
Unique shipment no. that is auto-generated
updated_at
string
| date-time
Nullable
Date and time of the most recent update to the bag status history record
updated_ts
string
Nullable
Timestamp indicating the last time the bag status history record was updated
bag_state_mapper
object (BagStateMapper)
BagStateMapper
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
The unique identifier associated with the state
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
The unique identifier associated with the bag
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Webhook shipment status, i.e., either create or update
display_name
string
Nullable
The display name of a shipment status as it appears on the platform
app_facing
boolean
action_user
object
id
number
bag_id
integer
Unique identifier for the bag.
entity_type
string
Nullable
Specifies the type of entity.
Enum
status
object (BagReturnableCancelableStatus)
BagReturnableCancelableStatus
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)
ShipmentItemFulFillingStore
phone
string
Nullable
Contact phone number for the store.
brand_store_tags
array of string
Nullable
Brand store tags
pincode
string
Nullable
Postal code (pincode) of the stores location.
meta
object
Nullable
Meta object for extra data
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
Formatted display version of the address
location_type
string
Nullable
Type of location of the fulfilling store.
Enum
id
integer
Unique identifier for the store.
code
string
Alphanumeric code representing the store.
store_email
string
Nullable
Store email
name
string
Nullable
Name of the store
state
string
Nullable
State where the store is located.
city
string
Nullable
City where the store is located.
tags
array of string
Nullable
Array of tags associated with the store
company_id
integer
Identifier of the company responsible for fulfilling shipments from this store
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)
Prices
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.
added_to_fynd_cash
boolean
gst_tax_percentage
number
tcs_percentage
number
cn_refund_amount
number
applied_emi_discount
number
applied_instant_discount
number
ordering_currency_prices
object (OrderingCurrencyPrices)
OrderingCurrencyPrices
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.
added_to_fynd_cash
number
gst_tax_percentage
number
tcs_percentage
number
cn_refund_amount
number
applied_emi_discount
number
applied_instant_discount
number
order_id
string
The unique identifier of the order for the shipment.
ordering_channnel
string
Nullable
The channel used for ordering the shipment.
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)
Currency
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
For particular code will show currency symbol
currency_info
object (CurrencyInfo)
CurrencyInfo
currency
object (CurrencyInfoCurrency)
CurrencyInfoCurrency
currency_code
string
currency_name
string
currency_sub_unit
string
currency_symbol
string
order_currency
string
conversion_rate
object (ConversionRate)
ConversionRate
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.
ordering_currency
object (OrderingCurrency)
OrderingCurrency
currency_code
string
Currency code like INR, UAE
currency_name
string
Currency name
currency_symbol
string
For particular code will show currency symbol
currency_sub_unit
string
Currency sub unit
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
Nullable
An object storing detailed logistics-related information, including courier partner details and other relevant metadata.
affiliate_shipment_id
string
Nullable
Identifier of the shipment assigned by the application
affiliate_order_id
string
Nullable
Identifier of the order assigned by the application
lane
string
Nullable
The lane associated with the shipment.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
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, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"00000000000000002"
lane:
"new"
search_type:
"shipment_id"
search_id:
"17289073504751136915"
search_value:
"16578901076461551493K"
from_date:
"2023-05-10"
to_date:
"2023-05-10"
dp_ids:
"19,26"
ordering_company_id:
"19"
stores:
"19,26"
sales_channel:
"000000000000000000000001,614b42d1ea943427b5f46d1e"
request_by_ext:
"kapture"
page_no:
1
page_size:
10
customer_id:
"63a2ce177e9f59d3166dd700"
exclude_locked_shipments:
true
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
Unique identifier of a company on the platform.
application_id
string
Required
A unique identifier for the application on the platform
shipment_id
string
Required
The unique identifier for the shipment
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.
PlatformShipmentTrack
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.
Array of PlatformTrack
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.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Using action, get reasons behind full or partial cancellation of a shipment
Parameters
company_id
integer
Required
application_id
string
Required
action
string
Required
Response
200
400
Success.
ShipmentReasonsResponseSchema
reasons
array of object (ShipmentResponseReasons)
Array of ShipmentResponseReasons
reason_id
integer
reason
string
message
string
success
boolean
Examples
Parameters
company_id:
2
application_id:
"5d63686df2a4f7806b76bb32"
action:
"cancel"
Was this section helpful?
GET
Response