Order

Manages orders, including processing, tracking, and updating order status.

Shipment

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

/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/{shipment_id}/line_number/{line_number}/reasons

# List bag cancellation reasons

GET

/service/platform/order/v1.0/company/{company_id}/application/{application_id}/shipments/

# List sales channel shipments

GET

/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/{shipment_id}/track

# Track shipment

GET

/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/reasons/{action}

# List shipment cancellation reasons

GET

List bag cancellation reasons

Get reasons to perform full or partial cancellation of a shipment

Parameters

company_id

integer

Required

Id of company

application_id

string

Required

Application ID of company

shipment_id

string

Required

ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.

line_number

integer

Required

line number of bag.

Response

200

4XX

5XX

Success. Check the example shown below or refer `ShipmentBagReasons` for more details.

ShipmentBagReasons

reasons

array of object (BagReasons)

Array of BagReasons

qc_type

array of string

integer

display_name

string

meta

object (BagReasonMeta)

BagReasonMeta

show_text_area

boolean

question_set

array of object (QuestionSet)

Array of QuestionSet

integer

display_name

string

reasons

array of object (BagReasons)

Array of BagReasons

success

boolean

Examples

Parameters

company_id:

application_id:

"value"

shipment_id:

"value"

line_number:

Was this section helpful?

GET

/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/{shipment_id}/line_number/{line_number}/reasons

Response

GET

List sales channel shipments

Get shipments of a particular sales channel based on the filters provided

Parameters

company_id

integer

Required

application_id

string

Required

lane

string

search_type

string

search_id

string

from_date

string

to_date

string

dp_ids

string

ordering_company_id

string

stores

string

sales_channel

string

request_by_ext

string

page_no

integer

page_size

integer

customer_id

string

is_priority_sort

boolean

Default Value : true

exclude_locked_shipments

boolean

Default Value : true

Response

200

4XX

We are processing the report!

ShipmentInternalPlatformViewResponse

total_count

integer

Nullable

message

string

Nullable

success

boolean

Nullable

items

array of object (ShipmentItem)

Array of ShipmentItem

order_date

string

Nullable

order_created_ts

string

Nullable

shipment_status

object (ShipmentStatus)

ShipmentStatus

current_shipment_status

string

Nullable

meta

object

Nullable

shipment_status_id

integer

Nullable

bag_list

array of string

Nullable

title

string

created_at

string

Nullable

created_ts

string

Nullable

shipment_id

string

Nullable

status_created_at

string

Nullable

status_created_ts

string

Nullable

status

string

Nullable

user

object (UserDataInfo)

UserDataInfo

uid

integer

Nullable

user_oid

string

Nullable

external_customer_id

string

Nullable

first_name

string

Nullable

last_name

string

Nullable

mobile

string

Nullable

string

Nullable

is_anonymous_user

boolean

Nullable

avis_user_id

string

Nullable

name

string

Nullable

gender

string

Nullable

estimated_sla_time

string

Nullable

estimated_sla_ts

string

Nullable

delivery_address

object (PlatformDeliveryAddress)

Nullable

PlatformDeliveryAddress

phone

string

Nullable

address2

string

Nullable

longitude

integer

Nullable

pincode

string

Nullable

area

string

Nullable

address_type

string

Nullable

country

string

Nullable

address_category

string

Nullable

string

Nullable

created_at

string

Nullable

address1

string

Nullable

display_address

string

Nullable

landmark

string

Nullable

updated_at

string

Nullable

version

string

Nullable

latitude

integer

Nullable

contact_person

string

Nullable

state

string

Nullable

city

string

Nullable

channel

object (ShipmentListingChannel)

ShipmentListingChannel

channel_shipment_id

string

Nullable

is_affiliate

boolean

Nullable

logo

string

Nullable

name

string

Nullable

previous_shipment_id

string

Nullable

lock_status

boolean

Nullable

invoice_id

string

Nullable

payment_methods

object

Nullable

payment_info

array of object

Nullable

status_created_at

string

status_created_ts

string

display_name

string

Nullable

bags

array of object (BagUnit)

Array of BagUnit

bag_type

string

Nullable

gst

object (GSTDetailsData)

GSTDetailsData

cgst_tax_percentage

number

Nullable

gstin_code

string

Nullable

value_of_good

number

gst_fee

number

igst_tax_percentage

number

Nullable

gst_tax_percentage

number

Nullable

hsn_code_id

string

Nullable

igst_gst_fee

number

Nullable

is_default_hsn_code

boolean

Nullable

sgst_gst_fee

number

Nullable

tax_collected_at_source

number

brand_calculated_amount

number

cgst_gst_fee

number

Nullable

gst_tag

string

Nullable

sgst_tax_percentage

number

Nullable

hsn_code

string

Nullable

financial_breakup

array of object (FinancialBreakup)

Array of FinancialBreakup

refund_credit

number

amount_paid_roundoff

integer

Nullable

price_effective

number

promotion_effective_discount

number

transfer_price

number

coupon_effective_discount

number

gst_fee

number

tax_collected_at_source

number

Nullable

brand_calculated_amount

number

delivery_charge

number

gst_tag

string

hsn_code

string

cashback

number

item_name

string

value_of_good

number

cashback_applied

number

cod_charges

number

price_marked

number

size

string

amount_paid

number

coupon_value

number

discount

number

fynd_credits

number

gst_tax_percentage

number

amount_to_be_collected

number

identifiers

object (Identifier)

Identifier

alu

string

Nullable

ean

string

Nullable

sku_code

string

Nullable

upc

string

Nullable

isbn

string

Nullable

total_units

integer

added_to_fynd_cash

boolean

bag_expiry_date

string

Nullable

bag_status

array of object (BagStatusHistory)

Array of BagStatusHistory

forward

boolean

Nullable

store_id

integer

Nullable

delivery_awb_number

string

Nullable

kafka_sync

boolean

Nullable

delivery_partner_id

integer

Nullable

app_display_name

string

Nullable

state_id

integer

Nullable

state_type

string

Nullable

bsh_id

integer

Nullable

created_at

string

Nullable

created_ts

string

Nullable

shipment_id

string

Nullable

updated_at

string

Nullable

updated_ts

string

Nullable

bag_state_mapper

object (BagStateMapper)

BagStateMapper

is_active

boolean

Nullable

app_display_name

string

Nullable

state_type

string

integer

journey_type

string

app_state_name

string

Nullable

name

string

app_facing

boolean

Nullable

notify_customer

boolean

Nullable

display_name

string

bag_id

integer

Nullable

reasons

array of object

Nullable

status

string

display_name

string

Nullable

current_operational_status

object (BagStatusHistory)

BagStatusHistory

forward

boolean

Nullable

store_id

integer

Nullable

delivery_awb_number

string

Nullable

kafka_sync

boolean

Nullable

delivery_partner_id

integer

Nullable

app_display_name

string

Nullable

state_id

integer

Nullable

state_type

string

Nullable

bsh_id

integer

Nullable

created_at

string

Nullable

created_ts

string

Nullable

shipment_id

string

Nullable

updated_at

string

Nullable

updated_ts

string

Nullable

bag_state_mapper

object (BagStateMapper)

BagStateMapper

is_active

boolean

Nullable

app_display_name

string

Nullable

state_type

string

integer

journey_type

string

app_state_name

string

Nullable

name

string

app_facing

boolean

Nullable

notify_customer

boolean

Nullable

display_name

string

bag_id

integer

Nullable

reasons

array of object

Nullable

status

string

display_name

string

Nullable

article

object (Article)

Article

child_details

object

Nullable

seller_identifier

string

uid

string

a_set

object

Nullable

dimensions

object (Dimensions)

Dimensions

height

number

Nullable

width

number

Nullable

is_default

boolean

Nullable

unit

string

Nullable

length

number

Nullable

currency

object

Nullable

esp_modified

boolean

Nullable

return_config

object (ReturnConfig)

Nullable

ReturnConfig

returnable

boolean

Nullable

time

number

Nullable

unit

string

Nullable

code

string

Nullable

weight

object (Weight)

Weight

is_default

boolean

Nullable

shipping

integer

Nullable

unit

string

Nullable

_id

string

identifiers

object

raw_meta

string

Nullable

size

string

is_set

boolean

Nullable

meta

object

Nullable

color

string

Nullable

department_id

integer

Nullable

images

array of string

Nullable

reasons

array of object

Nullable

product_quantity

integer

can_return

boolean

Nullable

display_name

string

Nullable

can_cancel

boolean

Nullable

size

string

Nullable

line_number

integer

Nullable

meta

object

Nullable

prices

object (Prices)

Prices

refund_credit

number

Nullable

amount_paid_roundoff

number

Nullable

price_effective

number

Nullable

promotion_effective_discount

number

Nullable

pm_price_split

number

Nullable

refund_amount

number

Nullable

transfer_price

number

Nullable

coupon_effective_discount

number

Nullable

tax_collected_at_source

number

Nullable

brand_calculated_amount

number

Nullable

delivery_charge

number

Nullable

cashback

number

Nullable

value_of_good

number

Nullable

cashback_applied

number

Nullable

cod_charges

number

Nullable

price_marked

number

Nullable

amount_paid

number

Nullable

coupon_value

number

Nullable

discount

number

Nullable

fynd_credits

number

Nullable

gift_price

number

Nullable

amount_to_be_collected

number

Nullable

dates

object (Dates)

Dates

delivery_date

string

Nullable

order_created

string

Nullable

current_status

object (BagStatusHistory)

BagStatusHistory

forward

boolean

Nullable

store_id

integer

Nullable

delivery_awb_number

string

Nullable

kafka_sync

boolean

Nullable

delivery_partner_id

integer

Nullable

app_display_name

string

Nullable

state_id

integer

Nullable

state_type

string

Nullable

bsh_id

integer

Nullable

created_at

string

Nullable

created_ts

string

Nullable

shipment_id

string

Nullable

updated_at

string

Nullable

updated_ts

string

Nullable

bag_state_mapper

object (BagStateMapper)

BagStateMapper

is_active

boolean

Nullable

app_display_name

string

Nullable

state_type

string

integer

journey_type

string

app_state_name

string

Nullable

name

string

app_facing

boolean

Nullable

notify_customer

boolean

Nullable

display_name

string

bag_id

integer

Nullable

reasons

array of object

Nullable

status

string

display_name

string

Nullable

bag_id

integer

entity_type

string

Nullable

status

object (BagReturnableCancelableStatus)

BagReturnableCancelableStatus

is_returnable

boolean

is_active

boolean

can_be_cancelled

boolean

enable_tracking

boolean

is_customer_return_allowed

boolean

fulfilling_store

object (ShipmentItemFulFillingStore)

ShipmentItemFulFillingStore

phone

string

Nullable

brand_store_tags

array of string

Nullable

pincode

string

Nullable

meta

object

Nullable

address

string

Nullable

address1

string

Nullable

display_address

string

Nullable

location_type

string

Nullable

integer

code

string

store_email

string

Nullable

name

string

Nullable

state

string

Nullable

city

string

Nullable

meta

object

payment_mode

string

Nullable

can_process

boolean

Nullable

prices

object (Prices)

Prices

refund_credit

number

Nullable

amount_paid_roundoff

number

Nullable

price_effective

number

Nullable

promotion_effective_discount

number

Nullable

pm_price_split

number

Nullable

refund_amount

number

Nullable

transfer_price

number

Nullable

coupon_effective_discount

number

Nullable

tax_collected_at_source

number

Nullable

brand_calculated_amount

number

Nullable

delivery_charge

number

Nullable

cashback

number

Nullable

value_of_good

number

Nullable

cashback_applied

number

Nullable

cod_charges

number

Nullable

price_marked

number

Nullable

amount_paid

number

Nullable

coupon_value

number

Nullable

discount

number

Nullable

fynd_credits

number

Nullable

gift_price

number

Nullable

amount_to_be_collected

number

Nullable

order_id

string

ordering_channnel

string

Nullable

shipment_id

string

Nullable

customer_note

string

Nullable

total_bags

integer

Nullable

shipment_created_at

string

mode_of_payment

string

shipment_created_ts

string

currency

object (Currency)

Currency

currency_code

string

currency_symbol

string

currency_info

object (CurrencyInfo)

CurrencyInfo

ordering_currency

object (OrderingCurrency)

OrderingCurrency

currency_code

string

currency_name

string

currency_symbol

string

currency_sub_unit

string

conversion_rate

object (ConversionRate)

ConversionRate

base

string

rates

object

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.

lane

string

Nullable

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.

Examples

Parameters

company_id:

application_id:

"value"

lane:

"value"

search_type:

"value"

search_id:

"value"

from_date:

"value"

to_date:

"value"

dp_ids:

"value"

ordering_company_id:

"value"

stores:

"value"

sales_channel:

"value"

request_by_ext:

"value"

page_no:

page_size:

customer_id:

"value"

is_priority_sort:

false

exclude_locked_shipments:

false

Was this section helpful?

GET

/service/platform/order/v1.0/company/{company_id}/application/{application_id}/shipments/

Response

GET

Track shipment

Track shipment by shipment Id for an application

Parameters

company_id

string

Required

Id of company

application_id

string

Required

Id of application

shipment_id

string

Required

Shipment Id

Response

200

4XX

5XX

Success. Check the example shown below or refer `PlatformShipmentTrack` for more details.

PlatformShipmentTrack

meta

object

results

array of object (PlatformTrack)

Array of PlatformTrack

last_location_recieved_at

string

meta

object

raw_status

string

updated_at

string

updated_time

string

awb

string

shipment_type

string

status

string

reason

string

account_name

string

Examples

Parameters

company_id:

"value"

application_id:

"value"

shipment_id:

"value"

Was this section helpful?

GET

/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/{shipment_id}/track

Response

GET

List shipment cancellation reasons

Get reasons to perform full or partial cancellation of a shipment

Parameters

company_id

integer

Required

application_id

string

Required

action

string

Required

Response

200

4XX

5XX

Success. Check the example shown below or refer `ShipmentReasonsResponse` for more details.

ShipmentReasonsResponse

reasons

array of object (ShipmentResponseReasons)

Array of ShipmentResponseReasons

reason_id

integer

reason

string

message

string

success

boolean

Examples

Parameters

company_id:

application_id:

"value"

action:

"value"

Was this section helpful?

GET

/service/platform/order/v1.0/company/{company_id}/application/{application_id}/orders/shipments/reasons/{action}

Response

« Browse files for Application

Create extension proxy »

Order

Shipment

List bag cancellation reasons

List bag cancellation reasons

getShipmentBagReasons

List sales channel shipments

List sales channel shipments

getApplicationShipments

Track shipment

Track shipment

trackShipmentPlatform

List shipment cancellation reasons

List shipment cancellation reasons

getPlatformShipmentReasons