{
"openapi": "3.0.1",
"info": {
"title": "Flipkart Marketplace API",
"description": "This API is offered by Flipkart Marketplace to sellers and partners for orders and listing management.
You will need an access token to explore our APIs in the sandbox environment. For details on getting an access token, refer to the documentation.
Once you get the access token, use it to authorize the requests using the Authorize
button below. e.g. if your access token is ACCTOK1
, the input for authorization should be Bearer ACCTOK1
",
"contact": {
"name": "API Support",
"email": "seller-api-queries@flipkart.com"
},
"version": "3.0"
},
"externalDocs": {
"description": "API Documentation",
"url": "https://seller.flipkart.com/api-docs/order-api-docs/OMAPIRef.html"
},
"servers": [
{
"url": "https://sandbox-api.flipkart.net/sellers"
}
],
"security": [
{
"Bearer": []
}
],
"tags": [
{
"name": "Orders V2"
},
{
"name": "Returns V2"
},
{
"name": "Shipment V3"
},
{
"name": "listingsCommonV3"
},
{
"name": "listingsFlipkartV3"
},
{
"name": "listingsHyperlocalV3"
},
{
"name": "Self Serve"
}
],
"paths": {
"/v2/orders/labels": {
"get": {
"tags": [
"Orders V2"
],
"summary": "Download labels and invoices in PDF format for order items",
"description": "This operation returns the labels and invoices for the order items in PDF format. Label and invoice must have been generated before invoking this method.",
"operationId": "getLabels",
"parameters": [
{
"name": "orderItemIds",
"in": "query",
"description": "Comma separated order items ids. Maximum 100 order item ids allowed per request.",
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
}
},
"post": {
"tags": [
"Orders V2"
],
"summary": "Trigger label generation for order items",
"description": "This operation triggers the generation of invoice and shipping labels for the order items and marks them as `PACKED`. Maximum 100 order items allowed per request.",
"operationId": "submitBulkConfirmRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenerateLabelRequestV2"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkConfirmResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/orders/shipments": {
"get": {
"tags": [
"Orders V2"
],
"summary": "Get shipping related details of order items",
"description": "This operation returns shipping and tracking related details of the order items e.g delivery / billing address, tracking id, buyer address, etc. Buyer contact number and email address would be provided only for self-ship orders.",
"operationId": "getShipments",
"parameters": [
{
"name": "orderItemIds",
"in": "query",
"description": "Comma separated order items ids. Maximum 100 order item ids allowed per request.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentSearchResponse"
}
}
}
}
}
}
},
"/v2/orders/search": {
"post": {
"tags": [
"Orders V2"
],
"summary": "Search order items using filters",
"description": "This operation returns order items based on applied filters",
"operationId": "searchOrderItemRequest",
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SearchOrderItemRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchOrderItemResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/orders/dispatch": {
"post": {
"tags": [
"Orders V2"
],
"summary": "Mark order items ready for dispatch",
"description": "This operation is used to mark the order items as `READY_TO_DISPATCH`. It must be invoked after downloading the invoice and label. Maximum 100 order items allowed per request.",
"operationId": "submitBulkRtdRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkRtdActionRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkRtdResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/orders/labelRequest/{requestId}": {
"get": {
"tags": [
"Orders V2"
],
"summary": "Check label generation status",
"description": "This operation returns the status of the label generation process which was triggered using `POST /v2/orders/labels` API. Query param `requestId` is the same value which is returned in the response of `POST /v2/orders/labels` API",
"operationId": "getBulkActionProgressByRequestId",
"parameters": [
{
"name": "requestId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkActionProgressResponse"
}
}
}
}
}
}
},
"/v2/orders/{order_item_id}": {
"get": {
"tags": [
"Orders V2"
],
"summary": "Get details of order item",
"description": "This operation returns details for the order item id.",
"operationId": "getOrderItemById",
"parameters": [
{
"name": "order_item_id",
"in": "path",
"description": "A single order item id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderItem"
}
}
}
}
}
}
},
"/v2/orders": {
"get": {
"tags": [
"Orders V2"
],
"summary": "Get details of order items",
"description": "This operation returns details for the order item ids passed in the query param. This is a bulk version of `GET /v2/orders/{order_item_id}` API",
"operationId": "getOrderItemsByIds",
"parameters": [
{
"name": "orderItemIds",
"in": "query",
"description": "Comma separated order item ids. Maximum 100 order item ids allowed per request.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FetchOrderItemsResponse"
}
}
}
}
}
}
},
"/v2/orders/manifest": {
"get": {
"tags": [
"Orders V2"
],
"summary": "Download manifest PDF",
"description": "This operation returns the manifest file in PDF format",
"operationId": "getManifestPdfForRequest",
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
}
}
},
"/v2/orders/cancel": {
"post": {
"tags": [
"Orders V2"
],
"summary": "Cancel order items",
"description": "This operation allows client to cancel order items before marking them `PACKED`. Maximum 100 order items allowed per request.",
"operationId": "cancelOrders",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelRequestV2"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderItemCancelResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/orders/invoices": {
"get": {
"tags": [
"Orders V2"
],
"summary": "Get invoice details for order items",
"description": "This operation returns the GST tax details, invoice number and date for the order items.",
"operationId": "getInvoicesInfo",
"parameters": [
{
"name": "orderItemIds",
"in": "query",
"description": "Comma separated order item ids. Maximum 100 order item ids allowed per request.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoicesSearchResponseV2"
}
}
}
}
}
}
},
"/v2/returns/complete": {
"post": {
"tags": [
"Returns V2"
],
"summary": "Update self-ship returns as complete",
"description": "This operation is used to mark the self-ship returns as complete. Maximum 100 returns allowed per request.",
"operationId": "returnComplete",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfShipReturnCompleteRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnsActionResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/returns": {
"get": {
"tags": [
"Returns V2"
],
"summary": "Fetch returns",
"description": "This operation is used to fetch returns based on given return created / modified date ranges or specific `returnIds` or `trackingIds`",
"operationId": "getReturns",
"parameters": [
{
"name": "source",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "modifiedAfter",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "modifiedBefore",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "createdAfter",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "createdBefore",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "returnIds",
"in": "query",
"description": "Comma separated return ids. Max. 25 allowed.",
"schema": {
"type": "string"
}
},
{
"name": "trackingIds",
"in": "query",
"description": "Comma separated tracking ids. Max. 25 allowed.",
"schema": {
"type": "string"
}
},
{
"name": "locationId",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnsSearchResponseV2"
}
}
}
}
}
}
},
"/v2/returns/pickup": {
"post": {
"tags": [
"Returns V2"
],
"summary": "Update self-ship returns pickup details",
"description": "This operation is used to update the pickup details of customer self-ship returns. Maximum 100 returns allowed per request.",
"operationId": "pickup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfShipReturnPickupRequests"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnsActionResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/returns/approve": {
"post": {
"tags": [
"Returns V2"
],
"summary": "Approve self-ship returns",
"description": "This operation is used to approve the self-ship returns. Maximum 100 returns allowed per request.",
"operationId": "approveSelfShipReturns",
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ReturnsApproveRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnsActionResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/returns/reject": {
"post": {
"tags": [
"Returns V2"
],
"summary": "Reject self-ship returns",
"description": "This operation is used to reject customer self-ship returns. Maximum 100 returns allowed per request.",
"operationId": "rejectSelfShipReturns",
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ReturnsRejectRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnsActionResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/returns/pickupAttempt": {
"post": {
"tags": [
"Returns V2"
],
"summary": "Update self-ship returns pickup attempt",
"description": "This operation is used to update the failed pickup attempt of self-ship returns. Maximum 100 returns allowed per request.",
"operationId": "pickupAttempt",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfShipReturnPickupAttemptRequests"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnsActionResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/returns/cancel": {
"post": {
"tags": [
"Returns V2"
],
"summary": "Cancel self-ship return",
"description": "This operation is used to cancel the self-ship return. Maximum 100 return ids allowed per request.",
"operationId": "cancelSelfShipReturn",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfShipReturnCancellationRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnsActionResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/services/complete": {
"post": {
"tags": [
"Orders V2"
],
"summary": "Update services as complete",
"description": "This operation is used to mark the services as complete. Maximum 100 services allowed per request.",
"operationId": "submitServiceCompleteRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceCompleteRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponseStatusV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/services/attempt": {
"post": {
"tags": [
"Orders V2"
],
"summary": "Update service attempts",
"description": "This operation is used to update the service attempt with failure reason and new delivery date. Maximum 100 services allowed per request.",
"operationId": "submitServiceAttemptRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceAttemptRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponseStatusV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/shipments/delivery": {
"post": {
"tags": [
"Orders V2"
],
"summary": "Update delivery date for self-ship order items",
"description": "This operation is used to update the delivery date for self-ship order items. Maximum 100 order items allowed per request.",
"operationId": "submitSelfShipDeliverRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentsDeliverRequestV2"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentsDeliverResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/shipments/dispatch": {
"post": {
"tags": [
"Orders V2"
],
"summary": "Mark self-ship order items ready for dispatch",
"description": "This operation is used to mark self-ship order items as `READY_TO_DISPATCH` from the seller warehouse. Maximum 100 shipments allowed per request.",
"operationId": "submitSelfShipmentDispatchRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentsDispatchRequestV2"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentsDispatchResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/shipments/deliveryAttempt": {
"post": {
"tags": [
"Orders V2"
],
"summary": "Update delivery attempt for self-ship order items",
"description": "This operation is used to update the delivery attempt with failure reason and new delivery date for the self-ship order items. Maximum 100 order items allowed per request.",
"operationId": "submitSelfShipDeliverAttemptRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentsDeliverAttemptRequestV2"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentsDeliverResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v3/shipments/labels": {
"post": {
"tags": [
"Shipment V3"
],
"summary": "Trigger label generation for shipments",
"description": "This operation triggers the generation of invoice and shipping labels for the shipment ids and marks shipments as `PACKED`. Maximum 25 shipments allower per request.",
"operationId": "pack",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentPackRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentStatusResponseV3"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v3/shipments/{shipmentIds}/labels": {
"get": {
"tags": [
"Shipment V3"
],
"summary": "Download labels and invoices in PDF format for shipments",
"description": "This operation returns the labels and invoices for the shipments in PDF format",
"operationId": "getLabels",
"parameters": [
{
"name": "shipmentIds",
"in": "path",
"description": "Comma separated shipment ids. Maximum 100 shipment ids allowed per request.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
}
}
},
"/v3/shipments/{shipmentId}/update": {
"post": {
"tags": [
"Shipment V3"
],
"summary": "Update Tracking Id of the Shipment",
"description": "This operation is used to update the Tracking Id for self-ship shipments.",
"operationId": "updateTrackingInfo",
"parameters": [
{
"name": "shipmentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateShipmentRequest"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v3/shipments/selfShip/deliveryAttempt": {
"post": {
"tags": [
"Shipment V3"
],
"summary": "Update delivery attempt for self-ship shipments",
"description": "This operation is used to update the delivery attempt with failure reason and new delivery date for the self-ship shipments. Maximum 100 shipments allowed per request.",
"operationId": "submitSelfShipDeliverAttemptRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentsDeliverAttemptRequestV2"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentsDeliverResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v3/shipments/filter": {
"get": {
"tags": [
"Shipment V3"
],
"summary": "Search shipments using filters",
"description": "This operation should be used if `hasMore` is true in the response of `POST /v3/shipments/filter` API, so that the client can fetch the next set of shipment which qualify the earlier defined filter criteria. User need not build this URL by themselves, just use the URL returned as `nextPageUrl` in the response of `POST /v3/shipments/filter` or `GET /v3/shipments/filter`.",
"operationId": "searchPreDispatchShipmentGet",
"parameters": [
{
"name": "next_token",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchShipmentResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Shipment V3"
],
"summary": "Search shipments using filters",
"description": "This operation returns shipments based on applied filters",
"operationId": "searchPreDispatchShipmentPost",
"requestBody": {
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SearchShipmentRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchShipmentResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v3/shipments/dispatch": {
"post": {
"tags": [
"Shipment V3"
],
"summary": "Mark shipments ready for dispatch",
"description": "This operation is used to mark the shipments as `READY_TO_DISPATCH` after the labels and invoices are generated and downloaded.",
"operationId": "markRTD",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DispatchShipmentRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentStatusResponseV3"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v3/shipments/selfShip/dispatch": {
"post": {
"tags": [
"Shipment V3"
],
"summary": "Mark self-ship shipments dispatched",
"description": "This operation is used to mark self-ship order items as `SHIPPED` from the seller warehouse. Maximum 100 shipments allowed per request.",
"operationId": "submitSelfShiptDispatchRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfshipDispatchRequestV3"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentsDispatchResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v3/shipments/cancel": {
"post": {
"tags": [
"Shipment V3"
],
"summary": "Cancel order items in a shipment",
"description": "This operation allows client to cancel order items inside shipment before marking them `PACKED`",
"operationId": "cancelByEnforcedGroupIds",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelShipmentRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentStatusResponseV3"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v3/shipments/{shipmentIds}/invoices": {
"get": {
"tags": [
"Shipment V3"
],
"summary": "Download invoice PDF",
"description": "This operation provides invoices for shipments in the PDF format. Label and invoice must have been generated before invoking this method.",
"operationId": "getInvoicesPdfFromEsi",
"parameters": [
{
"name": "shipmentIds",
"in": "path",
"description": "Comma separated shipment ids. Maximum 100 shipment ids allowed per request.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
}
}
},
"/v3/shipments/{shipmentIds}": {
"get": {
"tags": [
"Shipment V3"
],
"summary": "Get shipping related details for shipments",
"description": "This operation returns shipping and tracking related details of the shipments e.g delivery / billing address, tracking id, buyer address, etc. Buyer contact number and email address would be provided only for self-ship shipments.",
"operationId": "getShipmentDetails",
"parameters": [
{
"name": "shipmentIds",
"in": "path",
"description": "Comma separated shipment ids. Maximum 100 shipment ids allowed per request.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentDetailsResponseV3"
}
}
}
}
}
}
},
"/v3/shipments": {
"get": {
"tags": [
"Shipment V3"
],
"summary": "Get order details for given shipment or order ids",
"description": "This operation returns the order related details for the shipments. This operation can accept either shipmentIds, orderIds or orderItemIds, but only one type of query param is accepted per invocation.",
"operationId": "getShipmentDetailsByInternalId",
"parameters": [
{
"name": "shipmentIds",
"in": "query",
"description": "Comma separated shipment ids. Maximum 100 shipment ids allowed per request.",
"schema": {
"type": "string"
}
},
{
"name": "orderItemIds",
"in": "query",
"description": "Comma separated order item ids. Maximum 100 order item ids allowed per request.",
"schema": {
"type": "string"
}
},
{
"name": "orderIds",
"in": "query",
"description": "Comma separated order ids. Maximum 100 order ids allowed per request.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentResponse"
}
}
}
}
}
}
},
"/v3/shipments/handover/counts": {
"get": {
"tags": [
"Shipment V3"
],
"summary": "Get shipment handover counts per vendor",
"description": "This operation returns the count of shipments to be handed over to the logistics partner (E-Kart or 3rd party vendors)",
"operationId": "getVendorGroupDetails",
"parameters": [
{
"name": "locationId",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VendorGroupCodeDetailsResponseV3"
}
}
}
}
}
}
}
},
"/v3/shipments/{shipmentIds}/labelOnly/pdf": {
"post": {
"tags": [
"Shipment V3"
],
"summary": "Download labels in PDF format for shipments",
"description": "This operation returns the labels for the shipments in PDF format",
"operationId": "getLabelsOnlyPDF",
"parameters": [
{
"name": "shipmentIds",
"in": "path",
"description": "Comma separated shipment ids",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "reprint",
"in": "query",
"description": "True if you are reprinting Label",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
}
}
},
"/v3/shipments/{shipmentIds}/labelOnly": {
"post": {
"tags": [
"Shipment V3"
],
"summary": "Download labels Byte-Stream for shipments",
"description": "This operation returns the labels for the shipments in Byte-Stream format",
"operationId": "getLabelsOnly",
"parameters": [
{
"name": "shipmentIds",
"in": "path",
"description": "Comma separated shipmentIds",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "reprint",
"in": "query",
"description": "True to rePrint Label",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InputStream"
}
},
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/InputStream"
}
}
}
}
}
}
},
"/v3/shipments/selfShip/delivery": {
"post": {
"tags": [
"Shipment V3"
],
"summary": "Update delivery date for self-ship shipments",
"description": "This operation is used to update the delivery date for self-ship shipments. Maximum 100 shipments allowed per request.",
"operationId": "submitSelfShipDeliveryRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentsDeliverRequestV2"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentsDeliverResponseV2"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v3/shipments/manifest": {
"post": {
"tags": [
"Shipment V3"
],
"summary": "Download manifest PDF",
"description": "This operation returns the manifest file in PDF format",
"operationId": "getManifest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetManifestRequest"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v3/shipments/forms/updateAck": {
"post": {
"tags": [
"Shipment V3"
],
"summary": "Update logistics form acknowledgement number",
"description": "This operation allows client to update ACK number for form failed shipments. Maximum 25 shipments allowed per request.",
"operationId": "updateAckNumber",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentFormUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentStatusResponseV3"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v3/shipments/{shipmentIds}/forms": {
"post": {
"tags": [
"Shipment V3"
],
"summary": "Get forms for shipments",
"description": "This operation returns the forms associated with the shipments.",
"operationId": "getMandatoryForms",
"parameters": [
{
"name": "shipmentIds",
"in": "path",
"description": "Comma separated shipment ids. Maximum 100 shipment ids allowed per request.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MandatoryFormsResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v3/shipments/otc/{locationId}": {
"get": {
"tags": [
"Shipment V3"
],
"summary": "Get Return OTCs",
"description": "This operation returns the OTCs for Return type",
"operationId": "requestOTC",
"parameters": [
{
"name": "locationId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "requestType",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReverseOTCResponse"
}
}
}
}
}
}
}
},
"/listings/v3/update/price": {
"post": {
"operationId": "updatePrice",
"requestBody": {
"content": {
"application/json": {
"examples": {
"BasicPriceUpdate": {
"value": {
"random-sku-id": {
"product_id": "MOBFDG3VACEXZEYZ",
"price": {
"mrp": 100,
"selling_price": 90,
"currency": "INR"
}
}
}
}
},
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/UpdatePriceRequest"
},
"type": "object"
}
}
},
"description": "request",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/ListingChangeResponse"
},
"type": "object"
}
}
},
"description": "Successfully updated prices"
},
"400": {
"content": {},
"description": "Bad request"
},
"401": {
"content": {},
"description": "Client unauthorized"
},
"500": {
"content": {},
"description": "Internal Server Error"
}
},
"summary": "Update listing price request",
"tags": [
"listingsCommonV3"
],
"x-codegen-request-body-name": "body",
"x-content-type": "application/json",
"x-accepts": "application/json"
}
},
"/listings/v3/update/inventory": {
"post": {
"operationId": "updateInventory",
"requestBody": {
"content": {
"application/json": {
"examples": {
"BasicInventoryUpdate": {
"value": {
"random-sku-id": {
"product_id": "MOBFDG3VACEXZEYZ",
"locations": [
{
"id": "LOC9e98b1262cb544c59f9bb13c189214ed",
"inventory": 10
}
]
}
}
}
},
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/UpdateInventoryRequest"
},
"type": "object"
}
}
},
"description": "request",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/ListingChangeResponse"
},
"type": "object"
}
}
},
"description": "Successfully updated inventories"
},
"400": {
"content": {},
"description": "Bad request"
},
"401": {
"content": {},
"description": "Client unauthorized"
},
"500": {
"content": {},
"description": "Internal Server Error"
}
},
"summary": "Update listing inventory request",
"tags": [
"listingsCommonV3"
],
"x-codegen-request-body-name": "body",
"x-content-type": "application/json",
"x-accepts": "application/json"
}
},
"/listings/v3/{skuIds}": {
"get": {
"operationId": "getListings",
"parameters": [
{
"description": "sku-ids",
"explode": false,
"in": "path",
"name": "skuIds",
"required": true,
"schema": {
"type": "string"
},
"style": "simple"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetMarketplaceListingDetailsResponse"
}
}
},
"description": "Successfully got the response"
},
"400": {
"content": {},
"description": "Bad request"
},
"500": {
"content": {},
"description": "Internal Server Error"
}
},
"summary": "Get listings for SKUs",
"tags": [
"listingsCommonV3"
],
"x-accepts": "application/json"
}
},
"/listings/v3/update": {
"post": {
"operationId": "updateListings",
"requestBody": {
"content": {
"application/json": {
"examples": {
"BasicListingUpdate": {
"value": {
"seller-sku-id": {
"product_id": "MOBFDG3VACEXZEYZ",
"price": {
"mrp": 100,
"selling_price": 90,
"currency": "INR"
},
"tax": {
"hsn": "85171810",
"tax_code": "GST_5"
},
"listing_status": "ACTIVE",
"shipping_fees": {
"local": 10,
"zonal": 10,
"national": 20,
"currency": "INR"
},
"fulfillment_profile": "NON_FBF",
"fulfillment": {
"dispatch_sla": 1,
"shipping_provider": "FLIPKART",
"procurement_type": "REGULAR"
},
"packages": [
{
"name": "random-sku-id",
"dimensions": {
"length": 10,
"breadth": 10,
"height": 10
},
"weight": 100,
"description": "",
"handling": {
"fragile": true
},
"notional_value": {
"amount": 100,
"unit": "PERCENTAGE"
}
}
],
"locations": [
{
"id": "LOC9e98b1262cb544c59f9bb13c189214ed",
"status": "ENABLED",
"inventory": 10
}
],
"address_label": {
"manufacturer_details": [
"2nd floor X.Y.Z Complex, Bengaluru, Karnataka 560066"
],
"importer_details": [
"2nd floor X.Y.Z Complex, Bengaluru, Karnataka 560066"
],
"packer_details": [
"2nd floor X.Y.Z Complex, Bengaluru, Karnataka 560066"
],
"countries_of_origin": [
"IN"
]
},
"dating_label": {
"mfg_date": "1617806560",
"shelf_life": "155520000"
},
"archived_status": "NONE"
}
}
}
},
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/UpdateListingRequest"
},
"type": "object"
}
}
},
"description": "request",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/ListingChangeResponse"
},
"type": "object"
}
}
},
"description": "Successfully updated listings"
},
"400": {
"content": {},
"description": "Bad request"
},
"401": {
"content": {},
"description": "Client unauthorized"
},
"500": {
"content": {},
"description": "Internal Server Error"
}
},
"summary": "Update listing request",
"tags": [
"listingsFlipkartV3"
],
"x-codegen-request-body-name": "body",
"x-content-type": "application/json",
"x-accepts": "application/json"
}
},
"/listings/v3": {
"post": {
"operationId": "createListings",
"requestBody": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/CreateListingRequest"
},
"example": {
"seller-sku-id": {
"product_id": "MOBFDG3VACEXZEYZ",
"price": {
"mrp": 100,
"selling_price": 90,
"currency": "INR"
},
"tax": {
"hsn": "85171810",
"tax_code": "GST_5"
},
"listing_status": "ACTIVE",
"shipping_fees": {
"local": 10,
"zonal": 10,
"national": 20,
"currency": "INR"
},
"fulfillment_profile": "NON_FBF",
"fulfillment": {
"dispatch_sla": 1,
"shipping_provider": "FLIPKART",
"procurement_type": "REGULAR"
},
"packages": [
{
"name": "random-sku-id",
"dimensions": {
"length": 10,
"breadth": 10,
"height": 10
},
"weight": 100,
"description": "",
"handling": {
"fragile": true
},
"notional_value": {
"amount": 100,
"unit": "PERCENTAGE"
}
}
],
"locations": [
{
"id": "LOC9e98b1262cb544c59f9bb13c189214ed",
"status": "ENABLED",
"inventory": 10
}
],
"address_label": {
"manufacturer_details": [
"2nd floor X.Y.Z Complex, Bengaluru, Karnataka 560066"
],
"importer_details": [
"2nd floor X.Y.Z Complex, Bengaluru, Karnataka 560066"
],
"packer_details": [
"2nd floor X.Y.Z Complex, Bengaluru, Karnataka 560066"
],
"countries_of_origin": [
"IN"
]
},
"dating_label": {
"mfg_date": "1617806560",
"shelf_life": "155520000"
}
}
},
"type": "object"
}
}
},
"description": "request",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/ListingChangeResponse"
},
"type": "object"
}
}
},
"description": "Successfully created listings"
},
"400": {
"content": {},
"description": "Bad request"
},
"401": {
"content": {},
"description": "Client unauthorized"
},
"500": {
"content": {},
"description": "Internal Server Error"
}
},
"summary": "Create listing request",
"tags": [
"listingsFlipkartV3"
],
"x-codegen-request-body-name": "body",
"x-content-type": "application/json",
"x-accepts": "application/json"
}
},
"/listings/v3/hyperlocal/update": {
"post": {
"operationId": "updateListings",
"requestBody": {
"content": {
"application/json": {
"examples": {
"BasicHyperlocalListingUpdate": {
"value": {
"seller-sku-id": {
"product_id": "MOBFDG3VACEXZEYZ",
"price": {
"mrp": 100,
"selling_price": 90,
"currency": "INR"
},
"tax": {
"hsn": "85171810",
"tax_code": "GST_5"
},
"listing_status": "ACTIVE",
"package": {
"name": "random-sku-id",
"dimensions": {
"length": 10,
"breadth": 10,
"height": 10
},
"weight": 100,
"description": "",
"handling": {
"fragile": true
},
"notional_value": {
"amount": 100,
"unit": "PERCENTAGE"
}
},
"location": {
"id": "LOC9e98b1262cb544c59f9bb13c189214ed",
"status": "ENABLED",
"inventory": 10
},
"address_label": {
"manufacturer_details": [
"2nd floor X.Y.Z Complex, Bengaluru, Karnataka 560066"
],
"importer_details": [
"2nd floor X.Y.Z Complex, Bengaluru, Karnataka 560066"
],
"packer_details": [
"2nd floor X.Y.Z Complex, Bengaluru, Karnataka 560066"
],
"countries_of_origin": [
"IN"
]
},
"dating_label": {
"mfg_date": "1617806560",
"shelf_life": "155520000"
},
"archived_status": "NONE"
}
}
}
},
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/UpdateHyperlocalListingRequest"
},
"type": "object"
}
}
},
"description": "request",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/ListingChangeResponse"
},
"type": "object"
}
}
},
"description": "Successfully updated listings"
},
"400": {
"content": {},
"description": "Bad request"
},
"401": {
"content": {},
"description": "Client unauthorized"
},
"500": {
"content": {},
"description": "Internal Server Error"
}
},
"summary": "Update listing request",
"tags": [
"listingsHyperlocalV3"
],
"x-codegen-request-body-name": "body",
"x-content-type": "application/json",
"x-accepts": "application/json"
}
},
"/listings/v3/hyperlocal": {
"post": {
"operationId": "createListings",
"requestBody": {
"content": {
"application/json": {
"examples": {
"BasicHyperlocalListingCreate": {
"value": {
"seller-sku-id": {
"product_id": "MOBFDG3VACEXZEYZ",
"price": {
"mrp": 100,
"selling_price": 90,
"currency": "INR"
},
"tax": {
"hsn": "85171810",
"tax_code": "GST_5"
},
"listing_status": "ACTIVE",
"package": {
"name": "random-sku-id",
"dimensions": {
"length": 10,
"breadth": 10,
"height": 10
},
"weight": 100,
"description": "",
"handling": {
"fragile": true
},
"notional_value": {
"amount": 100,
"unit": "PERCENTAGE"
}
},
"location": {
"id": "LOC9e98b1262cb544c59f9bb13c189214ed",
"status": "ENABLED",
"inventory": 10
},
"address_label": {
"manufacturer_details": [
"2nd floor X.Y.Z Complex, Bengaluru, Karnataka 560066"
],
"importer_details": [
"2nd floor X.Y.Z Complex, Bengaluru, Karnataka 560066"
],
"packer_details": [
"2nd floor X.Y.Z Complex, Bengaluru, Karnataka 560066"
],
"countries_of_origin": [
"IN"
]
},
"dating_label": {
"mfg_date": "1617806560",
"shelf_life": "155520000"
}
}
}
}
},
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/CreateHyperlocalListingRequest"
},
"type": "object"
}
}
},
"description": "request",
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/ListingChangeResponse"
},
"type": "object"
}
}
},
"description": "Successfully created listings"
},
"400": {
"content": {},
"description": "Bad request"
},
"401": {
"content": {},
"description": "Client unauthorized"
},
"500": {
"content": {},
"description": "Internal Server Error"
}
},
"summary": "Create listing request",
"tags": [
"listingsHyperlocalV3"
],
"x-codegen-request-body-name": "body",
"x-content-type": "application/json",
"x-accepts": "application/json"
}
},
"/orders/sandbox/test_orders": {
"post": {
"tags": [
"Self Serve"
],
"summary": "Create test orders",
"description": "This operation creates test orders in sandbox",
"operationId": "createTestOrders",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createTestOrdersRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createTestOrdersResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/orders/sandbox/update_dispatch_slot": {
"post": {
"tags": [
"Self Serve"
],
"summary": "Change `dispatch_by_date` and `dispatch_after_date`",
"description": "This operation changes dispatch_by_date and dispatch_after_date for a specified order item. Please note dispatch dates should be in IST format. For ex 'dispatch_after_date':'YYYY-MM-DDTHH:MM:SS+05:30'",
"operationId": "changeDispatchSlots",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createTestOrdersRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createCourierReturnResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/orders/sandbox/on_hold": {
"put": {
"tags": [
"Self Serve"
],
"summary": "Put order on hold",
"description": "This operation puts specified order item on hold and sends notification for the same",
"operationId": "putOrderOnHold",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/putOrderOnHold"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createCourierReturnResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/orders/sandbox/un_hold": {
"put": {
"tags": [
"Self Serve"
],
"summary": "Mark order un hold",
"description": "This operation makes specified order item un hold from on hold",
"operationId": "makeOrderUnHold",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/makeOrderUnHold"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createCourierReturnResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/orders/sandbox/pick_up_complete": {
"post": {
"tags": [
"Self Serve"
],
"summary": "Mark order item as pick up complete",
"description": "This operation marks specified order item pick up complete and sends notification for the same",
"operationId": "markOrderItemPickupComplete",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/markOrderItemPickupComplete"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createCourierReturnResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/orders/sandbox/shipped": {
"post": {
"tags": [
"Self Serve"
],
"summary": "Mark order item as shipped",
"description": "This operation marks specified order item shipped and sends notification for the same",
"operationId": "markOrderItemShipped",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/markOrderItemShipped"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createCourierReturnResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/orders/sandbox/delivered": {
"post": {
"tags": [
"Self Serve"
],
"summary": "Mark order item as delivered",
"description": "This operation marks specified order item delivered and sends notification for the same",
"operationId": "markOrderItemDelivered",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/markOrderItemDelivered"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createCourierReturnResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/returns/sandbox/create_returns": {
"post": {
"tags": [
"Self Serve"
],
"summary": "Create courier or customer return",
"description": "This operation creates return for order in post dispatch state. The return type can be courier or customer",
"operationId": "createReturn",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createCourierReturnRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createCourierReturnResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/returns/sandbox/return_events": {
"post": {
"tags": [
"Self Serve"
],
"summary": "Process return events",
"description": "This operation marks return completed or cancelled and sends notification for the same",
"operationId": "processReturnEvents",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/processReturnEvents"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createCourierReturnResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/v2/shipments/sandbox/create_service/": {
"post": {
"tags": [
"Self Serve"
],
"summary": "Create forward or reverse services for drop ship orders",
"description": "This operation creates forward or reverse services for self ship order items. PS: Order items should be of type self ship. serviceType field should be either 'FORWARD' or 'REVERSE'",
"operationId": "createService",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createService"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createCourierReturnResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
}
},
"components": {
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
},
"schemas": {
"Address": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"pinCode": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"stateCode": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"landmark": {
"type": "string"
},
"contactNumber": {
"type": "string"
}
}
},
"BuyerDetails": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
}
}
},
"Courier": {
"type": "object",
"properties": {
"pickupDetails": {
"$ref": "#/components/schemas/CourierDetails"
},
"deliveryDetails": {
"$ref": "#/components/schemas/CourierDetails"
}
}
},
"CourierDetails": {
"type": "object",
"properties": {
"trackingId": {
"type": "string"
},
"vendorName": {
"type": "string"
}
}
},
"OrderItem": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"orderId": {
"type": "string"
},
"cancellationGroupId": {
"type": "string"
},
"orderDate": {
"type": "string",
"format": "date-time"
},
"cancellationDate": {
"type": "string",
"format": "date-time"
},
"paymentType": {
"type": "string",
"enum": [
"COD",
"PREPAID"
]
},
"status": {
"type": "string",
"enum": [
"APPROVED",
"PACKING_IN_PROGRESS",
"FORM_FAILED",
"PACKED",
"READY_TO_DISPATCH",
"PICKUP_COMPLETE",
"CANCELLED",
"RETURN_REQUESTED",
"RETURNED",
"SHIPPED",
"DELIVERED",
"COMPLETED"
]
},
"cancellationReason": {
"type": "string"
},
"cancellationSubReason": {
"type": "string"
},
"courierReturn": {
"type": "boolean"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"fsn": {
"type": "string"
},
"sku": {
"type": "string"
},
"listingId": {
"type": "string"
},
"hsn": {
"type": "string"
},
"title": {
"type": "string"
},
"packageIds": {
"type": "array",
"items": {
"type": "string"
}
},
"priceComponents": {
"$ref": "#/components/schemas/PriceComponent"
},
"serviceProfile": {
"type": "string",
"enum": [
"Flipkart_Fulfilment",
"Seller_Fulfilment",
"Smart_Fulfilment",
"FBF",
"NON_FBF",
"FBF_LITE"
]
},
"is_replacement": {
"type": "boolean"
}
}
},
"ShipmentDetails": {
"type": "object",
"properties": {
"orderId": {
"type": "string"
},
"shipmentId": {
"type": "string"
},
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItem"
}
},
"weighingRequired": {
"type": "boolean"
},
"deliveryAddress": {
"$ref": "#/components/schemas/Address"
},
"billingAddress": {
"$ref": "#/components/schemas/Address"
},
"buyerDetails": {
"$ref": "#/components/schemas/BuyerDetails"
},
"sellerAddress": {
"$ref": "#/components/schemas/Address"
},
"returnAddress": {
"$ref": "#/components/schemas/Address"
},
"courierDetails": {
"$ref": "#/components/schemas/Courier"
}
}
},
"ShipmentSearchResponse": {
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentDetails"
}
}
}
},
"PriceComponents": {
"type": "object",
"properties": {
"sellingPrice": {
"type": "number",
"format": "float"
},
"customerPrice": {
"type": "number",
"format": "float"
},
"shippingCharge": {
"type": "number",
"format": "float"
},
"totalPrice": {
"type": "number",
"format": "float"
},
"flipkartDiscount": {
"type": "number",
"format": "float"
},
"subsidy": {
"type": "number",
"format": "float"
}
}
},
"SearchOrderItemResponseV2": {
"type": "object",
"properties": {
"hasMore": {
"type": "boolean"
},
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItem"
}
},
"url": {
"type": "string"
},
"nextPageUrl": {
"type": "string"
},
"previousPageUrl": {
"type": "string"
}
}
},
"Service": {
"type": "object",
"properties": {
"serviceFulfilmentId": {
"type": "string"
},
"description": {
"type": "string"
},
"serviceByDate": {
"type": "string"
},
"createdAt": {
"type": "string"
}
}
},
"DateFilter": {
"type": "object",
"properties": {
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"Filter": {
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"preDispatch",
"postDispatch",
"cancelled"
]
},
"states": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"APPROVED",
"PACKING_IN_PROGRESS",
"FORM_FAILED",
"PACKED",
"READY_TO_DISPATCH",
"PICKUP_COMPLETE",
"CANCELLED",
"RETURN_REQUESTED",
"RETURNED",
"SHIPPED",
"DELIVERED",
"COMPLETED"
]
}
},
"locationId": {
"type": "string"
},
"sku": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"orderDate": {
"$ref": "#/components/schemas/DateFilter"
},
"dispatchAfterDate": {
"$ref": "#/components/schemas/DateFilter"
},
"dispatchByDate": {
"$ref": "#/components/schemas/DateFilter"
},
"modifiedDate": {
"$ref": "#/components/schemas/DateFilter"
},
"shipmentTypes": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"EXPRESS",
"NORMAL",
"SELF"
]
}
},
"serviceProfiles": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"FBF",
"NON_FBF",
"FBF_LITE"
]
}
},
"dispatchServiceTiers": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"EXPRESS",
"REGULAR"
]
}
},
"cancellationDate": {
"$ref": "#/components/schemas/DateFilter"
},
"cancellationType": {
"type": "string",
"enum": [
"sellerCancellation",
"buyerCancellation",
"marketplaceCancellation"
]
}
}
},
"Pagination": {
"type": "object",
"properties": {
"pageSize": {
"type": "integer",
"format": "int32"
}
}
},
"SearchOrderItemRequest": {
"type": "object",
"properties": {
"filter": {
"$ref": "#/components/schemas/Filter"
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"sort": {
"$ref": "#/components/schemas/Sort"
}
}
},
"Sort": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"dispatchByDate",
"orderDate",
"modifiedDate",
"dispatchAfterDate"
]
},
"order": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
},
"BulkConfirmItem": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"processingStatus": {
"type": "string"
},
"errorMessage": {
"type": "string"
},
"errorCode": {
"type": "string"
}
}
},
"BulkConfirmResponseV2": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkConfirmItem"
}
}
}
},
"GenerateLabelRequestItemV2": {
"required": [
"invoiceDate",
"orderItemId",
"taxRate"
],
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"taxRate": {
"maximum": 100,
"minimum": 0,
"type": "number"
},
"invoiceNumber": {
"type": "string"
},
"serialNumbers": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"invoiceDate": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"subItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenerateLabelRequestItemV2"
}
}
}
},
"GenerateLabelRequestV2": {
"required": [
"orderItems"
],
"type": "object",
"properties": {
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenerateLabelRequestItemV2"
}
}
}
},
"BulkRtdRequestItemStatus": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"errorCode": {
"type": "string"
},
"errorMessage": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"BulkRtdResponse": {
"type": "object",
"properties": {
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkRtdRequestItemStatus"
}
}
}
},
"BulkOrderItem": {
"required": [
"orderItemId",
"quantity"
],
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int64"
}
}
},
"BulkRtdActionRequest": {
"type": "object",
"properties": {
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkOrderItem"
}
}
}
},
"BulkActionProgressResponse": {
"type": "object",
"properties": {
"confirmedCount": {
"type": "integer",
"format": "int32"
},
"errorCount": {
"type": "integer",
"format": "int32"
},
"completedCount": {
"type": "integer",
"format": "int32"
},
"processingCount": {
"type": "integer",
"format": "int32"
},
"orderItemDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkConfirmedItem"
}
},
"complete": {
"type": "boolean"
}
}
},
"BulkConfirmedItem": {
"type": "object",
"properties": {
"orderItemId": {
"type": "integer",
"format": "int64"
},
"processingStatus": {
"type": "string"
},
"errorMessage": {
"type": "string"
},
"errorCode": {
"type": "string"
}
}
},
"FetchOrderItemsResponse": {
"type": "object",
"properties": {
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItem"
}
}
}
},
"FailedCancellations": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"reason": {
"type": "string"
}
}
},
"OrderItemCancelResponse": {
"type": "object",
"properties": {
"cancelled": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"failedCancellations": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/FailedCancellations"
}
}
}
},
"CancelOrderItemRequest": {
"required": [
"orderItemId",
"reason"
],
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"reason": {
"type": "string"
}
}
},
"CancelRequestV2": {
"type": "object",
"properties": {
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CancelOrderItemRequest"
}
}
}
},
"InvoiceDetails": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"invoiceDate": {
"type": "string",
"format": "date"
},
"invoiceNumber": {
"type": "string"
},
"invoiceAmount": {
"type": "number"
},
"taxRate": {
"type": "number"
},
"serialNumbers": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"taxDetails": {
"$ref": "#/components/schemas/TaxDetails"
}
}
},
"InvoicesSearchResponseV2": {
"type": "object",
"properties": {
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceDetails"
}
}
}
},
"TaxDetails": {
"type": "object",
"properties": {
"cgstRate": {
"type": "number"
},
"sgstRate": {
"type": "number"
},
"igstRate": {
"type": "number"
}
}
},
"ReturnActionResponse": {
"type": "object",
"properties": {
"returnId": {
"type": "string"
},
"processingStatus": {
"type": "string"
},
"errorCode": {
"type": "string"
},
"errorMessage": {
"type": "string"
}
}
},
"ReturnsActionResponseV2": {
"type": "object",
"properties": {
"returns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReturnActionResponse"
}
}
}
},
"SelfShipReturnCompleteRequest": {
"required": [
"returnIds"
],
"type": "object",
"properties": {
"returnIds": {
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"locationId": {
"type": "string"
}
}
},
"ReturnItem": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"locationId": {
"type": "string"
},
"orderId": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"orderDate": {
"type": "string"
},
"createdDate": {
"type": "string"
},
"courierName": {
"type": "string"
},
"sellerId": {
"type": "string"
},
"returnId": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"reason": {
"type": "string"
},
"subReason": {
"type": "string"
},
"trackingId": {
"type": "string"
},
"shipmentStatus": {
"type": "string"
},
"shipmentId": {
"type": "string"
},
"comments": {
"type": "string"
},
"updatedDate": {
"type": "string"
},
"approvedOn": {
"type": "string"
},
"expectedDate": {
"type": "string"
},
"serviceProfile": {
"type": "string",
"enum": [
"Flipkart_Fulfilment",
"Seller_Fulfilment",
"Smart_Fulfilment",
"FBF",
"NON_FBF",
"FBF_LITE"
]
},
"services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Service"
}
}
}
},
"ReturnsSearchResponseV2": {
"type": "object",
"properties": {
"hasMore": {
"type": "boolean"
},
"nextUrl": {
"type": "string"
},
"returnItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReturnItem"
}
}
}
},
"SelfShipReturnPickupRequest": {
"required": [
"pickupDate"
],
"type": "object",
"properties": {
"returnId": {
"type": "string"
},
"pickupDate": {
"type": "string",
"format": "date-time"
}
}
},
"SelfShipReturnPickupRequests": {
"required": [
"returns"
],
"type": "object",
"properties": {
"returns": {
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/SelfShipReturnPickupRequest"
}
},
"locationId": {
"type": "string"
}
}
},
"ReturnApproveRequest": {
"type": "object",
"properties": {
"returnId": {
"type": "string"
},
"serviceFulfilmentId": {
"type": "string"
},
"serviceDate": {
"type": "string",
"format": "date-time"
},
"comments": {
"type": "string"
}
}
},
"ReturnsApproveRequest": {
"required": [
"returns"
],
"type": "object",
"properties": {
"returns": {
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ReturnApproveRequest"
}
},
"locationId": {
"type": "string"
}
}
},
"ReturnRejectRequest": {
"required": [
"serviceDate"
],
"type": "object",
"properties": {
"returnId": {
"type": "string"
},
"serviceFulfilmentId": {
"type": "string"
},
"serviceDate": {
"type": "string",
"format": "date-time"
},
"comments": {
"type": "string"
}
}
},
"ReturnsRejectRequest": {
"required": [
"returns"
],
"type": "object",
"properties": {
"returns": {
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ReturnRejectRequest"
}
},
"locationId": {
"type": "string"
}
}
},
"SelfShipReturnAttemptPickupRequest": {
"required": [
"newPickupDate",
"pickupDate"
],
"type": "object",
"properties": {
"returnId": {
"type": "string"
},
"pickupDate": {
"type": "string",
"format": "date-time"
},
"newPickupDate": {
"type": "string",
"format": "date-time"
},
"reason": {
"type": "string"
}
}
},
"SelfShipReturnPickupAttemptRequests": {
"required": [
"returns"
],
"type": "object",
"properties": {
"returns": {
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/SelfShipReturnAttemptPickupRequest"
}
},
"locationId": {
"type": "string"
}
}
},
"SelfShipReturnCancellationRequest": {
"required": [
"returnIds"
],
"type": "object",
"properties": {
"returnIds": {
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"locationId": {
"type": "string"
}
}
},
"RequestStatus": {
"type": "object",
"properties": {
"serviceFulfilmentId": {
"type": "string"
},
"status": {
"type": "string"
},
"failureReason": {
"type": "string"
}
}
},
"ServiceResponseStatusV2": {
"type": "object",
"properties": {
"services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestStatus"
}
}
}
},
"DeliverRequest": {
"required": [
"deliveryDate"
],
"type": "object",
"properties": {
"shipmentId": {
"type": "string"
},
"locationId": {
"type": "string"
},
"deliveryDate": {
"type": "string",
"format": "date-time"
}
}
},
"DeliverAttemptRequest": {
"required": [
"deliveryDate"
],
"type": "object",
"properties": {
"shipmentId": {
"type": "string"
},
"locationId": {
"type": "string"
},
"deliveryDate": {
"type": "string",
"format": "date-time"
},
"failureAttributes": {
"$ref": "#/components/schemas/FailureAttributes"
}
}
},
"ServiceAttemptDeliverRequest": {
"required": [
"serviceFulfilmentId",
"reason",
"subReason",
"deliveryDate",
"newDeliveryDate"
],
"type": "object",
"properties": {
"serviceFulfilmentId": {
"type": "string"
},
"reason": {
"type": "string"
},
"subReason": {
"type": "string"
},
"comments": {
"type": "string"
},
"deliveryDate": {
"type": "string",
"format": "date-time"
},
"newDeliveryDate": {
"type": "string",
"format": "date-time"
}
}
},
"ServiceCompleteDeliverRequest": {
"required": [
"serviceFulfilmentId",
"deliveryDate"
],
"type": "object",
"properties": {
"serviceFulfilmentId": {
"type": "string"
},
"deliveryDate": {
"type": "string",
"format": "date-time"
}
}
},
"ServiceCompleteRequest": {
"required": [
"services"
],
"type": "object",
"properties": {
"services": {
"description": "Maximum 100 services allowed per request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceCompleteDeliverRequest"
}
}
}
},
"ServiceAttemptRequest": {
"required": [
"services"
],
"type": "object",
"properties": {
"services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceAttemptDeliverRequest"
}
}
}
},
"ShipmentResponseStatusV2": {
"type": "object",
"properties": {
"shipmentId": {
"type": "string"
},
"processingStatus": {
"type": "string"
},
"errorCode": {
"type": "string"
},
"errorMessage": {
"type": "string"
}
}
},
"ShipmentsDeliverResponseV2": {
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentResponseStatusV2"
}
}
}
},
"ShipmentsDeliverRequestV2": {
"required": [
"shipments"
],
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliverRequest"
}
}
}
},
"ShipmentsDispatchResponseV2": {
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentResponseStatusV2"
}
}
}
},
"ConfirmItemRow": {
"required": [
"invoiceDate",
"taxRate"
],
"type": "object",
"properties": {
"serialNumbers": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"invoiceDate": {
"type": "string",
"format": "date"
},
"invoiceNumber": {
"type": "string"
},
"orderItemId": {
"type": "string"
},
"taxRate": {
"type": "number"
},
"quantity": {
"minimum": 1,
"type": "integer",
"format": "int32"
}
}
},
"DispatchRequest": {
"required": [
"dispatchDate",
"orderItems",
"tentativeDeliveryDate"
],
"type": "object",
"properties": {
"shipmentId": {
"type": "string"
},
"tentativeDeliveryDate": {
"type": "string",
"format": "date-time"
},
"deliveryPartner": {
"type": "string"
},
"dispatchDate": {
"type": "string",
"format": "date-time"
},
"trackingId": {
"type": "string"
},
"facilityId": {
"type": "string"
},
"locationId": {
"type": "string"
},
"orderItems": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfirmItemRow"
}
}
}
},
"ShipmentsDispatchRequestV2": {
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DispatchRequest"
}
}
}
},
"FailureAttributes": {
"required": [
"newDeliveryDate"
],
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"subReason": {
"type": "string"
},
"newDeliveryDate": {
"type": "string",
"format": "date-time"
}
}
},
"ShipmentsDeliverAttemptRequestV2": {
"required": [
"shipments"
],
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliverAttemptRequest"
}
}
}
},
"Shipment": {
"type": "object",
"properties": {
"shipmentId": {
"type": "string"
},
"dispatchByDate": {
"type": "string",
"format": "date-time"
},
"dispatchAfterDate": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"locationId": {
"type": "string"
},
"hold": {
"type": "boolean"
},
"mps": {
"type": "boolean"
},
"packagingPolicy": {
"type": "string"
},
"subShipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubShipment"
}
},
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItem"
}
},
"forms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Form"
}
},
"shipmentType": {
"type": "string"
}
}
},
"ShipmentStatusResponse": {
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Shipment"
}
}
}
},
"Dimensions": {
"type": "object",
"properties": {
"length": {
"type": "number"
},
"breadth": {
"type": "number"
},
"height": {
"type": "number"
},
"weight": {
"type": "number"
}
}
},
"Invoice": {
"type": "object",
"properties": {
"shipmentId": {
"type": "string"
},
"invoiceDate": {
"type": "string",
"format": "date"
},
"invoiceNumber": {
"type": "string"
},
"fssaiLicenseNo": {
"type": "string"
},
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItems"
}
}
}
},
"PackRequest": {
"type": "object",
"properties": {
"shipmentId": {
"type": "string"
},
"locationId": {
"type": "string"
},
"taxItems": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxItem"
}
},
"serialNumbers": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/SerialNumber"
}
},
"invoices": {
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/PackRequestInvoice"
}
},
"subShipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubShipments"
}
},
"ignoreWarning": {
"type": "boolean"
}
}
},
"SerialNumber": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"serialNumbers": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"ShipmentPackRequest": {
"type": "object",
"properties": {
"shipments": {
"maxItems": 25,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/PackRequest"
}
}
}
},
"SubShipments": {
"required": [
"dimensions",
"subShipmentId"
],
"type": "object",
"properties": {
"subShipmentId": {
"type": "string"
},
"dimensions": {
"$ref": "#/components/schemas/Dimensions"
}
}
},
"TaxItem": {
"required": [
"taxRate"
],
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"purchasePrice": {
"type": "number",
"format": "double"
},
"taxRate": {
"type": "number"
},
"quantity": {
"minimum": 1,
"type": "integer",
"format": "int32"
}
}
},
"UpdateShipmentRequest": {
"type": "object",
"properties": {
"shipment_id": {
"type": "string"
},
"tracking_id": {
"type": "string"
},
"seller_id": {
"type": "string"
},
"delivery_partner": {
"type": "string"
},
"tentative_delivery_date": {
"type": "string",
"format": "date-time"
}
}
},
"Form": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"link": {
"type": "string"
},
"automated": {
"type": "boolean"
}
}
},
"Package": {
"example": {
"notional_value": {
"amount": 0.7386281948385884,
"unit": "PERCENTAGE"
},
"name": "name",
"weight": 4.145608029883936,
"description": "description",
"handling": {
"fragile": true
},
"id": "id",
"dimensions": {
"breadth": 3.616076749251911,
"length": 9.301444243932576,
"height": 2.027123023002322
}
},
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"dimensions": {
"$ref": "#/components/schemas/Dimension"
},
"weight": {
"type": "number"
},
"notional_value": {
"$ref": "#/components/schemas/NotionalValue"
},
"description": {
"type": "string"
},
"handling": {
"$ref": "#/components/schemas/Handling"
}
},
"required": [
"name"
],
"type": "object"
},
"PriceComponent": {
"type": "object",
"properties": {
"sellingPrice": {
"type": "number"
},
"totalPrice": {
"type": "number"
},
"shippingCharge": {
"type": "number"
},
"customerPrice": {
"type": "number"
},
"flipkartDiscount": {
"type": "number"
}
}
},
"SearchShipmentResponse": {
"type": "object",
"properties": {
"hasMore": {
"type": "boolean"
},
"nextPageUrl": {
"type": "string"
},
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Shipment"
}
}
}
},
"SubShipment": {
"type": "object",
"properties": {
"subShipmentId": {
"type": "string"
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Package"
}
}
}
},
"SearchShipmentRequest": {
"type": "object",
"properties": {
"filter": {
"$ref": "#/components/schemas/Filter"
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"sort": {
"$ref": "#/components/schemas/Sort"
},
"sellerId": {
"type": "string"
}
}
},
"DispatchShipmentRequest": {
"type": "object",
"properties": {
"shipmentIds": {
"maxItems": 25,
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"locationId": {
"type": "string"
}
}
},
"DispatchAddress": {
"type": "object",
"properties": {
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"landmark": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"pincode": {
"type": "string"
}
}
},
"DispatchLocation": {
"required": [
"address"
],
"type": "object",
"properties": {
"locationId": {
"type": "string"
},
"address": {
"$ref": "#/components/schemas/DispatchAddress"
}
}
},
"DispatchRequestV3": {
"required": [
"dispatchDate",
"invoice",
"tentativeDeliveryDate"
],
"type": "object",
"properties": {
"shipmentId": {
"type": "string"
},
"tentativeDeliveryDate": {
"type": "string",
"format": "date-time"
},
"dispatchDate": {
"type": "string",
"format": "date-time"
},
"deliveryPartner": {
"type": "string"
},
"trackingId": {
"type": "string"
},
"locationId": {
"type": "string"
},
"invoice": {
"$ref": "#/components/schemas/InvoiceRequest"
},
"dispatchLocation": {
"$ref": "#/components/schemas/DispatchLocation"
}
}
},
"InvoiceItem": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"quantity": {
"minimum": 1,
"type": "integer",
"format": "int32"
},
"serialNumbers": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"InvoiceRequest": {
"required": [
"invoiceDate",
"items"
],
"type": "object",
"properties": {
"invoiceNumber": {
"type": "string"
},
"invoiceDate": {
"type": "string",
"format": "date"
},
"items": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/InvoiceItem"
}
}
}
},
"SelfshipDispatchRequestV3": {
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DispatchRequestV3"
}
}
}
},
"CancelShipment": {
"type": "object",
"properties": {
"shipmentId": {
"type": "string"
},
"reason": {
"type": "string"
},
"locationId": {
"type": "string"
},
"cancellationGroupIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CancelShipmentRequest": {
"type": "object",
"properties": {
"shipments": {
"maxItems": 25,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/CancelShipment"
}
}
}
},
"InvoiceDetailsResponseV3": {
"type": "object",
"properties": {
"invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice"
}
}
}
},
"OrderItems": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"invoiceAmount": {
"type": "number"
},
"taxRate": {
"type": "number"
},
"serialNumbers": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"taxDetails": {
"$ref": "#/components/schemas/TaxDetails"
}
}
},
"SellerAddress": {
"type": "object",
"properties": {
"sellerName": {
"type": "string"
},
"pinCode": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"stateCode": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"landmark": {
"type": "string"
}
}
},
"ShipmentDetailsResponseV3": {
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Shipment"
}
}
}
},
"ShipmentResponse": {
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Shipment"
}
}
}
},
"Otc": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"error_code": {
"type": "string"
}
}
},
"PickUpDate": {
"type": "object",
"properties": {
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"VendorGroupCodeDetailsResponseV3": {
"type": "object",
"properties": {
"vendorGroupCode": {
"type": "string"
},
"count": {
"type": "integer",
"format": "int32"
},
"pickUpDate": {
"$ref": "#/components/schemas/PickUpDate"
},
"otc": {
"$ref": "#/components/schemas/Otc"
},
"isMps": {
"type": "boolean"
}
}
},
"ReverseOTCResponse": {
"type": "object",
"properties": {
"otcs": {
"type": "array",
"$ref": "#/components/schemas/OTCResponse"
}
}
},
"OTCResponse": {
"type": "object",
"properties": {
"requestType": {
"type": "string"
},
"status": {
"type": "string"
},
"otc": {
"type": "array",
"$ref": "#/components/schemas/OtcV2"
}
}
},
"OtcV2": {
"properties": {
"type": {
"type": "string"
},
"code": {
"type": "string"
},
"vendor": {
"type": "string"
}
}
},
"InputStream": {
"type": "object"
},
"GetManifestRequest": {
"required": [
"params"
],
"type": "object",
"properties": {
"params": {
"$ref": "#/components/schemas/Params"
}
}
},
"Params": {
"required": [
"vendorGroupCode"
],
"type": "object",
"properties": {
"vendorGroupCode": {
"type": "string"
},
"pickupDate": {
"$ref": "#/components/schemas/PickUpDate"
},
"locationId": {
"type": "string"
},
"is_mps": {
"type": "boolean"
}
}
},
"ShipmentFormUpdateRequest": {
"required": [
"shipments"
],
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FormUpdate"
}
}
}
},
"FormUpdate": {
"required": [
"shipmentId",
"forms"
],
"type": "object",
"properties": {
"shipmentId": {
"type": "string"
},
"forms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentFormUpdateForm"
}
}
}
},
"ShipmentFormUpdateForm": {
"required": [
"name",
"ackNumber"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"ackNumber": {
"type": "string"
}
}
},
"MandatoryFormsResponse": {
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MandatoryFormsResponseShipment"
}
}
}
},
"MandatoryFormsResponseShipment": {
"type": "object",
"properties": {
"shipmentId": {
"type": "string"
},
"forms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Forms"
}
}
}
},
"Forms": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"link": {
"type": "string"
},
"automated": {
"type": "boolean"
},
"status": {
"type": "string"
}
}
},
"ShipmentStatusResponseV3": {
"type": "object",
"properties": {
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentV3"
}
}
}
},
"ShipmentV3": {
"type": "object",
"properties": {
"shipmentId": {
"type": "string"
},
"status": {
"type": "string"
},
"errorCode": {
"type": "string"
},
"errorMessage": {
"type": "string"
}
}
},
"PackRequestInvoice": {
"required": [
"orderId",
"invoiceDate"
],
"type": "object",
"properties": {
"orderId": {
"type": "string"
},
"invoiceDate": {
"type": "string",
"format": "date-time"
},
"invoiceNumber": {
"type": "string"
}
}
},
"UpdatePriceRequest": {
"example": {
"price": {
"selling_price": 0,
"nlc": 5,
"dealer_price": 5,
"mrp": 0,
"currency": "INR",
"mop": 1
},
"product_id": "product_id"
},
"properties": {
"product_id": {
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Price"
}
},
"required": [
"price",
"product_id"
],
"type": "object"
},
"ListingChangeResponse": {
"properties": {
"status": {
"enum": [
"SUCCESS",
"FAILURE",
"WARNING"
],
"type": "string"
},
"errors": {
"items": {
"$ref": "#/components/schemas/Error"
},
"type": "array"
},
"attribute_errors": {
"items": {
"$ref": "#/components/schemas/AttributeError"
},
"type": "array"
}
},
"required": [
"attribute_errors",
"errors",
"status"
],
"type": "object"
},
"UpdateInventoryRequest": {
"example": {
"product_id": "product_id",
"locations": [
{
"id": "id",
"pending_inventory": 6,
"inventory": 0,
"status": "ENABLED"
},
{
"id": "id",
"pending_inventory": 6,
"inventory": 0,
"status": "ENABLED"
}
]
},
"properties": {
"product_id": {
"type": "string"
},
"locations": {
"items": {
"$ref": "#/components/schemas/Location"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"locations",
"product_id"
],
"type": "object"
},
"GetMarketplaceListingDetailsResponse": {
"example": {
"unavailable": [
"unavailable",
"unavailable"
],
"available": {
"key": {
"fulfillment_profile": "NON_FBF",
"shipping_fees": {
"national": 0,
"currency": "INR",
"local": 0,
"zonal": 0
},
"listing_id": "listing_id",
"price": {
"selling_price": 0,
"nlc": 5,
"dealer_price": 5,
"mrp": 0,
"currency": "INR",
"mop": 1
},
"product_id": "product_id",
"listing_status": "ACTIVE",
"archived_status": "ARCHIVED",
"tax": {
"is_gst_sellable": true,
"hsn": "hsn",
"tax_code": "tax_code",
"goods_services_rate": 2.242318933290832,
"luxury_cess_percentage": 60.27456183070403
},
"locations": [
{
"id": "id",
"pending_inventory": 6,
"inventory": 0,
"status": "ENABLED"
},
{
"id": "id",
"pending_inventory": 6,
"inventory": 0,
"status": "ENABLED"
}
],
"packages": [
{
"notional_value": {
"amount": 0.20271230230023218,
"unit": "PERCENTAGE"
},
"name": "name",
"weight": 3.616076749251911,
"description": "description",
"handling": {
"fragile": true
},
"id": "id",
"dimensions": {
"breadth": 7.061401241503109,
"length": 2.3021358869347655,
"height": 9.301444243932576
}
},
{
"notional_value": {
"amount": 0.20271230230023218,
"unit": "PERCENTAGE"
},
"name": "name",
"weight": 3.616076749251911,
"description": "description",
"handling": {
"fragile": true
},
"id": "id",
"dimensions": {
"breadth": 7.061401241503109,
"length": 2.3021358869347655,
"height": 9.301444243932576
}
}
]
}
},
"invalid": [
"invalid",
"invalid"
]
},
"properties": {
"available": {
"additionalProperties": {
"$ref": "#/components/schemas/MarketplaceListingDetail"
},
"type": "object"
},
"unavailable": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"invalid": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"available"
],
"type": "object"
},
"Price": {
"example": {
"selling_price": 0,
"nlc": 5,
"dealer_price": 5,
"mrp": 0,
"currency": "INR",
"mop": 1
},
"properties": {
"mrp": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"selling_price": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"mop": {
"format": "int32",
"type": "integer"
},
"nlc": {
"format": "int32",
"type": "integer"
},
"dealer_price": {
"format": "int32",
"type": "integer"
},
"currency": {
"example": "INR",
"format": "iso-4217",
"type": "string"
}
},
"required": [
"currency",
"mrp",
"selling_price"
],
"type": "object"
},
"Error": {
"properties": {
"severity": {
"enum": [
"ERROR",
"WARNING"
],
"type": "string"
},
"code": {
"format": "int32",
"type": "integer"
},
"description": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"code",
"description",
"severity"
],
"type": "object"
},
"AttributeError": {
"properties": {
"severity": {
"enum": [
"ERROR",
"WARNING"
],
"type": "string"
},
"code": {
"format": "int32",
"type": "integer"
},
"description": {
"type": "string"
},
"attribute": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"attribute",
"code",
"description",
"severity"
],
"type": "object"
},
"Location": {
"example": {
"id": "id",
"pending_inventory": 1,
"inventory": 1,
"status": "ENABLED"
},
"properties": {
"id": {
"type": "string"
},
"status": {
"enum": [
"ENABLED",
"DISABLED"
],
"type": "string"
},
"inventory": {
"format": "int32",
"type": "integer"
},
"pending_inventory": {
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"status"
],
"type": "object"
},
"MarketplaceListingDetail": {
"example": {
"fulfillment_profile": "NON_FBF",
"shipping_fees": {
"national": 0,
"currency": "INR",
"local": 0,
"zonal": 0
},
"listing_id": "listing_id",
"price": {
"selling_price": 0,
"nlc": 5,
"dealer_price": 5,
"mrp": 0,
"currency": "INR",
"mop": 1
},
"product_id": "product_id",
"listing_status": "ACTIVE",
"archived_status": "ARCHIVED",
"tax": {
"is_gst_sellable": true,
"hsn": "hsn",
"tax_code": "tax_code",
"goods_services_rate": 2.242318933290832,
"luxury_cess_percentage": 60.27456183070403
},
"locations": [
{
"id": "id",
"pending_inventory": 6,
"inventory": 0,
"status": "ENABLED"
},
{
"id": "id",
"pending_inventory": 6,
"inventory": 0,
"status": "ENABLED"
}
],
"packages": [
{
"notional_value": {
"amount": 0.20271230230023218,
"unit": "PERCENTAGE"
},
"name": "name",
"weight": 3.616076749251911,
"description": "description",
"handling": {
"fragile": true
},
"id": "id",
"dimensions": {
"breadth": 7.061401241503109,
"length": 2.3021358869347655,
"height": 9.301444243932576
}
},
{
"notional_value": {
"amount": 0.20271230230023218,
"unit": "PERCENTAGE"
},
"name": "name",
"weight": 3.616076749251911,
"description": "description",
"handling": {
"fragile": true
},
"id": "id",
"dimensions": {
"breadth": 7.061401241503109,
"length": 2.3021358869347655,
"height": 9.301444243932576
}
}
]
},
"properties": {
"listing_id": {
"type": "string"
},
"product_id": {
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Price"
},
"tax": {
"$ref": "#/components/schemas/Tax"
},
"listing_status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"shipping_fees": {
"$ref": "#/components/schemas/ShippingFees"
},
"fulfillment_profile": {
"enum": [
"NON_FBF",
"FBF_LITE",
"FBF"
],
"type": "string"
},
"packages": {
"items": {
"$ref": "#/components/schemas/Package"
},
"type": "array",
"uniqueItems": true
},
"locations": {
"items": {
"$ref": "#/components/schemas/Location"
},
"type": "array"
},
"archived_status": {
"enum": [
"ARCHIVED",
"NONE"
],
"type": "string"
}
},
"required": [
"fulfillment_profile",
"listing_id",
"listing_status",
"price",
"product_id"
],
"type": "object"
},
"Currency": {
"example": "INR",
"format": "iso-4217",
"type": "string"
},
"Tax": {
"example": {
"is_gst_sellable": true,
"hsn": "hsn",
"tax_code": "tax_code",
"goods_services_rate": 6.445980483417342,
"luxury_cess_percentage": 70.61401241503108
},
"properties": {
"hsn": {
"type": "string"
},
"is_gst_sellable": {
"type": "boolean"
},
"goods_services_rate": {
"maximum": 28,
"minimum": 0,
"type": "number"
},
"tax_code": {
"type": "string"
},
"luxury_cess_percentage": {
"maximum": 100.0,
"minimum": 0,
"type": "number"
}
},
"required": [
"hsn"
],
"type": "object"
},
"ShippingFees": {
"example": {
"national": 0,
"currency": "INR",
"local": 0,
"zonal": 0
},
"properties": {
"local": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"zonal": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"national": {
"format": "int32",
"minimum": 0,
"type": "integer"
},
"currency": {
"example": "INR",
"format": "iso-4217",
"type": "string"
}
},
"required": [
"currency",
"local",
"national",
"zonal"
],
"type": "object"
},
"Dimension": {
"example": {
"breadth": 3.616076749251911,
"length": 9.301444243932576,
"height": 2.027123023002322
},
"properties": {
"length": {
"type": "number"
},
"breadth": {
"type": "number"
},
"height": {
"type": "number"
}
},
"required": [
"breadth",
"height",
"length"
],
"type": "object"
},
"NotionalValue": {
"example": {
"amount": 0.7386281948385884,
"unit": "PERCENTAGE"
},
"properties": {
"amount": {
"minimum": 0,
"type": "number"
},
"unit": {
"enum": [
"PERCENTAGE",
"INR"
],
"type": "string"
}
},
"required": [
"amount",
"unit"
],
"type": "object"
},
"Handling": {
"example": {
"fragile": true
},
"properties": {
"fragile": {
"type": "boolean"
}
},
"required": [
"fragile"
],
"type": "object"
},
"UpdateListingRequest": {
"example": {
"shipping_fees": {
"national": 0,
"currency": "INR",
"local": 0,
"zonal": 0
},
"dating_label": {
"mfg_date": 0,
"expiry_date": 9,
"shelf_life": 5
},
"tax": {
"is_gst_sellable": true,
"hsn": "hsn",
"tax_code": "tax_code",
"goods_services_rate": 6.445980483417342,
"luxury_cess_percentage": 70.61401241503108
},
"address_label": {
"importer_details": [
"importer_details",
"importer_details",
"importer_details",
"importer_details",
"importer_details"
],
"manufacturer_details": [
"manufacturer_details",
"manufacturer_details",
"manufacturer_details",
"manufacturer_details",
"manufacturer_details"
],
"countries_of_origin": [
"countries_of_origin",
"countries_of_origin",
"countries_of_origin",
"countries_of_origin",
"countries_of_origin"
],
"packer_details": [
"packer_details",
"packer_details",
"packer_details",
"packer_details",
"packer_details"
]
},
"packages": [
{
"notional_value": {
"amount": 0.684685269835264,
"unit": "PERCENTAGE"
},
"name": "name",
"weight": 1.4894159098541704,
"description": "description",
"handling": {
"fragile": true
},
"id": "id",
"dimensions": {
"breadth": 1.2315135367772556,
"length": 7.386281948385884,
"height": 1.0246457001441578
}
},
{
"notional_value": {
"amount": 0.684685269835264,
"unit": "PERCENTAGE"
},
"name": "name",
"weight": 1.4894159098541704,
"description": "description",
"handling": {
"fragile": true
},
"id": "id",
"dimensions": {
"breadth": 1.2315135367772556,
"length": 7.386281948385884,
"height": 1.0246457001441578
}
}
],
"fulfillment_profile": "NON_FBF",
"price": {
"selling_price": 0,
"nlc": 5,
"dealer_price": 5,
"mrp": 0,
"currency": "INR",
"mop": 1
},
"product_id": "product_id",
"listing_status": "ACTIVE",
"archived_status": "ARCHIVED",
"subsidized_shipping": true,
"locations": [
{
"id": "id",
"pending_inventory": 1,
"inventory": 7,
"status": "ENABLED"
},
{
"id": "id",
"pending_inventory": 1,
"inventory": 7,
"status": "ENABLED"
}
],
"fulfillment": {
"region_restriction": "zonal",
"procurement_type": "EXPRESS",
"shipping_provider": "FLIPKART",
"dispatch_sla": 1
}
},
"properties": {
"product_id": {
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Price"
},
"tax": {
"$ref": "#/components/schemas/Tax"
},
"listing_status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"shipping_fees": {
"$ref": "#/components/schemas/ShippingFees"
},
"subsidized_shipping": {
"type": "boolean"
},
"fulfillment_profile": {
"enum": [
"NON_FBF",
"FBF_LITE",
"FBF"
],
"type": "string"
},
"fulfillment": {
"$ref": "#/components/schemas/Fulfillment"
},
"packages": {
"items": {
"$ref": "#/components/schemas/Package"
},
"type": "array",
"uniqueItems": true
},
"locations": {
"items": {
"$ref": "#/components/schemas/Location"
},
"type": "array",
"uniqueItems": true
},
"address_label": {
"$ref": "#/components/schemas/AddressLabel"
},
"dating_label": {
"$ref": "#/components/schemas/DatingLabel"
},
"archived_status": {
"enum": [
"ARCHIVED",
"NONE"
],
"type": "string"
}
},
"required": [
"fulfillment_profile",
"listing_status",
"locations",
"packages",
"price",
"product_id",
"tax"
],
"type": "object"
},
"CreateListingRequest": {
"example": {
"fulfillment_profile": "NON_FBF",
"shipping_fees": {
"national": 0,
"currency": "INR",
"local": 0,
"zonal": 0
},
"dating_label": {
"mfg_date": 0,
"expiry_date": 9,
"shelf_life": 5
},
"price": {
"selling_price": 0,
"nlc": 5,
"dealer_price": 5,
"mrp": 0,
"currency": "INR",
"mop": 1
},
"product_id": "product_id",
"listing_status": "ACTIVE",
"subsidized_shipping": true,
"tax": {
"is_gst_sellable": true,
"hsn": "hsn",
"tax_code": "tax_code",
"goods_services_rate": 6.445980483417342,
"luxury_cess_percentage": 70.61401241503108
},
"locations": [
{
"id": "id",
"pending_inventory": 1,
"inventory": 7,
"status": "ENABLED"
},
{
"id": "id",
"pending_inventory": 1,
"inventory": 7,
"status": "ENABLED"
}
],
"address_label": {
"importer_details": [
"importer_details",
"importer_details",
"importer_details",
"importer_details",
"importer_details"
],
"manufacturer_details": [
"manufacturer_details",
"manufacturer_details",
"manufacturer_details",
"manufacturer_details",
"manufacturer_details"
],
"countries_of_origin": [
"countries_of_origin",
"countries_of_origin",
"countries_of_origin",
"countries_of_origin",
"countries_of_origin"
],
"packer_details": [
"packer_details",
"packer_details",
"packer_details",
"packer_details",
"packer_details"
]
},
"fulfillment": {
"region_restriction": "zonal",
"procurement_type": "EXPRESS",
"shipping_provider": "FLIPKART",
"dispatch_sla": 1
},
"packages": [
{
"notional_value": {
"amount": 0.684685269835264,
"unit": "PERCENTAGE"
},
"name": "name",
"weight": 1.4894159098541704,
"description": "description",
"handling": {
"fragile": true
},
"id": "id",
"dimensions": {
"breadth": 1.2315135367772556,
"length": 7.386281948385884,
"height": 1.0246457001441578
}
},
{
"notional_value": {
"amount": 0.684685269835264,
"unit": "PERCENTAGE"
},
"name": "name",
"weight": 1.4894159098541704,
"description": "description",
"handling": {
"fragile": true
},
"id": "id",
"dimensions": {
"breadth": 1.2315135367772556,
"length": 7.386281948385884,
"height": 1.0246457001441578
}
}
]
},
"properties": {
"product_id": {
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Price"
},
"tax": {
"$ref": "#/components/schemas/Tax"
},
"listing_status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"shipping_fees": {
"$ref": "#/components/schemas/ShippingFees"
},
"subsidized_shipping": {
"type": "boolean"
},
"fulfillment_profile": {
"enum": [
"NON_FBF",
"FBF_LITE",
"FBF"
],
"type": "string"
},
"fulfillment": {
"$ref": "#/components/schemas/Fulfillment"
},
"packages": {
"items": {
"$ref": "#/components/schemas/Package"
},
"type": "array",
"uniqueItems": true
},
"locations": {
"items": {
"$ref": "#/components/schemas/Location"
},
"type": "array",
"uniqueItems": true
},
"address_label": {
"$ref": "#/components/schemas/AddressLabel"
},
"dating_label": {
"$ref": "#/components/schemas/DatingLabel"
}
},
"required": [
"fulfillment_profile",
"listing_status",
"locations",
"packages",
"price",
"product_id",
"tax"
],
"type": "object"
},
"Fulfillment": {
"example": {
"region_restriction": "zonal",
"procurement_type": "EXPRESS",
"shipping_provider": "FLIPKART",
"dispatch_sla": 1
},
"properties": {
"dispatch_sla": {
"format": "int32",
"minimum": 1,
"type": "integer"
},
"shipping_provider": {
"enum": [
"FLIPKART",
"SELLER",
"FLIPKART_SELLER",
"SELLER_FLIPKART"
],
"type": "string"
},
"procurement_type": {
"enum": [
"EXPRESS",
"REGULAR",
"INTERNATIONAL",
"MADE_TO_ORDER",
"DOMESTIC"
],
"type": "string"
},
"region_restriction": {
"enum": [
"zonal",
"national",
"none"
],
"type": "string"
}
},
"required": [
"dispatch_sla",
"procurement_type",
"shipping_provider"
],
"type": "object"
},
"AddressLabel": {
"example": {
"importer_details": [
"importer_details",
"importer_details",
"importer_details",
"importer_details",
"importer_details"
],
"manufacturer_details": [
"manufacturer_details",
"manufacturer_details",
"manufacturer_details",
"manufacturer_details",
"manufacturer_details"
],
"countries_of_origin": [
"countries_of_origin",
"countries_of_origin",
"countries_of_origin",
"countries_of_origin",
"countries_of_origin"
],
"packer_details": [
"packer_details",
"packer_details",
"packer_details",
"packer_details",
"packer_details"
]
},
"properties": {
"manufacturer_details": {
"items": {
"type": "string"
},
"maxItems": 5,
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"importer_details": {
"items": {
"type": "string"
},
"maxItems": 5,
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"packer_details": {
"items": {
"type": "string"
},
"maxItems": 5,
"minItems": 0,
"type": "array",
"uniqueItems": true
},
"countries_of_origin": {
"items": {
"type": "string"
},
"maxItems": 5,
"minItems": 0,
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"DatingLabel": {
"example": {
"mfg_date": 0,
"expiry_date": 7,
"shelf_life": 6
},
"properties": {
"mfg_date": {
"format": "int64",
"minimum": 0,
"type": "integer"
},
"shelf_life": {
"format": "int64",
"type": "integer"
},
"expiry_date": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"UpdateHyperlocalListingRequest": {
"example": {
"package": {
"notional_value": {
"amount": 0.7386281948385884,
"unit": "PERCENTAGE"
},
"name": "name",
"weight": 4.145608029883936,
"description": "description",
"handling": {
"fragile": true
},
"id": "id",
"dimensions": {
"breadth": 3.616076749251911,
"length": 9.301444243932576,
"height": 2.027123023002322
}
},
"dating_label": {
"mfg_date": 0,
"expiry_date": 7,
"shelf_life": 6
},
"price": {
"selling_price": 0,
"nlc": 5,
"dealer_price": 5,
"mrp": 0,
"currency": "INR",
"mop": 1
},
"product_id": "product_id",
"listing_status": "ACTIVE",
"archived_status": "ARCHIVED",
"tax": {
"is_gst_sellable": true,
"hsn": "hsn",
"tax_code": "tax_code",
"goods_services_rate": 6.445980483417342,
"luxury_cess_percentage": 70.61401241503108
},
"location": {
"id": "id",
"pending_inventory": 1,
"inventory": 1,
"status": "ENABLED"
},
"address_label": {
"importer_details": [
"importer_details",
"importer_details",
"importer_details",
"importer_details",
"importer_details"
],
"manufacturer_details": [
"manufacturer_details",
"manufacturer_details",
"manufacturer_details",
"manufacturer_details",
"manufacturer_details"
],
"countries_of_origin": [
"countries_of_origin",
"countries_of_origin",
"countries_of_origin",
"countries_of_origin",
"countries_of_origin"
],
"packer_details": [
"packer_details",
"packer_details",
"packer_details",
"packer_details",
"packer_details"
]
}
},
"properties": {
"product_id": {
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Price"
},
"tax": {
"$ref": "#/components/schemas/Tax"
},
"listing_status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"package": {
"$ref": "#/components/schemas/Package"
},
"location": {
"$ref": "#/components/schemas/Location"
},
"address_label": {
"$ref": "#/components/schemas/AddressLabel"
},
"dating_label": {
"$ref": "#/components/schemas/DatingLabel"
},
"archived_status": {
"enum": [
"ARCHIVED",
"NONE"
],
"type": "string"
}
},
"required": [
"listing_status",
"location",
"price",
"product_id",
"tax"
],
"type": "object"
},
"CreateHyperlocalListingRequest": {
"example": {
"package": {
"notional_value": {
"amount": 0.7386281948385884,
"unit": "PERCENTAGE"
},
"name": "name",
"weight": 4.145608029883936,
"description": "description",
"handling": {
"fragile": true
},
"id": "id",
"dimensions": {
"breadth": 3.616076749251911,
"length": 9.301444243932576,
"height": 2.027123023002322
}
},
"dating_label": {
"mfg_date": 0,
"expiry_date": 7,
"shelf_life": 6
},
"price": {
"selling_price": 0,
"nlc": 5,
"dealer_price": 5,
"mrp": 0,
"currency": "INR",
"mop": 1
},
"product_id": "product_id",
"listing_status": "ACTIVE",
"tax": {
"is_gst_sellable": true,
"hsn": "hsn",
"tax_code": "tax_code",
"goods_services_rate": 6.445980483417342,
"luxury_cess_percentage": 70.61401241503108
},
"location": {
"id": "id",
"pending_inventory": 1,
"inventory": 1,
"status": "ENABLED"
},
"address_label": {
"importer_details": [
"importer_details",
"importer_details",
"importer_details",
"importer_details",
"importer_details"
],
"manufacturer_details": [
"manufacturer_details",
"manufacturer_details",
"manufacturer_details",
"manufacturer_details",
"manufacturer_details"
],
"countries_of_origin": [
"countries_of_origin",
"countries_of_origin",
"countries_of_origin",
"countries_of_origin",
"countries_of_origin"
],
"packer_details": [
"packer_details",
"packer_details",
"packer_details",
"packer_details",
"packer_details"
]
}
},
"properties": {
"product_id": {
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Price"
},
"tax": {
"$ref": "#/components/schemas/Tax"
},
"listing_status": {
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string"
},
"package": {
"$ref": "#/components/schemas/Package"
},
"location": {
"$ref": "#/components/schemas/Location"
},
"address_label": {
"$ref": "#/components/schemas/AddressLabel"
},
"dating_label": {
"$ref": "#/components/schemas/DatingLabel"
}
},
"required": [
"address_label",
"dating_label",
"listing_status",
"location",
"package",
"price",
"product_id",
"tax"
],
"type": "object"
},
"createCourierReturnResponse": {
"type": "object",
"properties": {
"response": {
"type": "string"
}
}
},
"createCourierReturnRequest": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"returnType": {
"type": "string"
}
}
},
"processReturnEvents": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"eventType": {
"type": "string"
}
}
},
"putOrderOnHold": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
}
}
},
"makeOrderUnHold": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
}
}
},
"markOrderItemPickupComplete": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
}
}
},
"markOrderItemShipped": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
}
}
},
"markOrderItemDelivered": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
}
}
},
"createTestOrdersRequest": {
"type": "object",
"properties": {
"shipmentType": {
"type": "string"
},
"locationId": {
"type": "string"
},
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/createOrderItem"
}
}
}
},
"createOrderItem": {
"type": "object",
"properties": {
"listingId": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int64"
},
"subItem": {
"$ref": "#/components/schemas/subItemRequest"
}
}
},
"createTestOrdersResponse": {
"type": "object",
"properties": {
"orderId": {
"type": "string"
},
"orderItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/createOrderItemResponse"
}
}
}
},
"createOrderItemResponse": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"listingId": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int64"
}
}
},
"subItemRequest": {
"type": "object",
"properties": {
"listingId": {
"type": "string"
}
}
},
"subItemResponse": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"listingId": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int64"
}
}
},
"changeDispatchSlots": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"dispatchAfterDate": {
"type": "string",
"format": "date-time"
},
"dispatchByDate": {
"type": "string",
"format": "date-time"
}
}
},
"createService": {
"type": "object",
"properties": {
"orderItemId": {
"type": "string"
},
"serviceType": {
"type": "string"
}
}
}
}
}
}