{ "openapi": "3.1.0", "info": { "contact": { "email": "support@scanpower.com", "name": "ScanPower Support", "url": "https://www.scanpower.com" }, "description": "Public facing APIs for sellers, prep-centers, and integrators.", "license": { "name": "ScanPower API", "url": "https://www.scanpower.com/license" }, "title": "ScanPower API", "version": "2.0" }, "servers": [ { "description": "endpoint for us-east region", "url": "https://unity.scanpower.com" }, { "description": "endpoint for us-west region", "url": "https://west.scanpower.com" }, { "description": "endpoint for eu-west region", "url": "https://uk.scanpower.com" } ], "security": [ { "basic_auth": [] } ], "paths": { "/api/v2/users": { "get": { "description": "Get a list of active users (parent and sub users)", "operationId": "getUsers", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "properties": { "id": { "description": "The internal id for a ScanPower user. A v4 UUID.", "type": "string" }, "name": { "description": "The user's buisness or personal name.", "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Account" ], "summary": "Get a list of active users (parent and sub users)" } }, "/account": { "get": { "summary": "Get a list of Client Proxy Users", "description": "Get a list of client proxy users", "operationId": "getProxyUsers", "parameters": [ { "description": "The proxy indicator", "example": "proxy", "in": "query", "name": "proxy", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "properties": { "email": { "items": { "description": "An email address", "type": "string" }, "type": "array" }, "id": { "description": "The internal id for a ScanPower user. A v4 UUID.", "type": "string" }, "misc": { "description": "Some additional details, documented are just some of the common ones. Others may be returned that were either one-off values or are no longer used.", "properties": { "active": { "description": "Tracks sub-users' active status", "type": "boolean" }, "autoSyncInventory": { "description": "False if we shouldn't sync inventory on login", "type": "boolean" }, "default-return-status": { "description": "When an order is returned, default the return status to this.", "type": "string" }, "deleted": { "description": "If the user has been deleted, this will be a timestamp representing when the user was deleted.", "type": "string" }, "region": { "description": "Users are saved in both east and west regions. We check this on login to see which server to direct the user to.", "type": "string" }, "sync-orders": { "description": "Set to false to prevent orders and settlements from saving.", "type": "boolean" }, "trackTime": { "description": "Set to true to track how long a (sub-)user is logged in.", "type": "boolean" } }, "type": "object" }, "name": { "description": "The user's buisness or personal name.", "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "basic_auth": [] } ], "tags": [ "Account", "Prep Center" ] } }, "/api/v2/token": { "get": { "summary": "Get an API token", "description": "All other API calls require the token that this endpoint provides", "operationId": "getApiToken", "parameters": [ { "description": "The ID of a user you have proxy access to. If provided, the returned token will allow you to make API calls on behalf of this user.", "in": "header", "name": "X-Proxy", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "examples": { "success": { "value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..." } }, "schema": { "type": "string" } } }, "description": "A token was generated and returned in the response body" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "basic_auth": [] } ], "tags": [ "Auth" ] } }, "/api/az/access-token": { "get": { "description": "Get an access token from Amazon with which to make SP-API calls.", "operationId": "getAccessToken", "parameters": [ { "description": "The marketplace to perform operations in.", "example": "US", "in": "query", "name": "marketplace", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_token": { "type": "string" }, "expires_in": { "type": "integer", "example": 3600, "description": "How many seconds until the token expires." } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Auth", "Amazon" ], "summary": "Get an access token from Amazon with which to make SP-API calls." } }, "/api/az/catalog/items": { "get": { "summary": "Search Catalog Items", "description": "Wrapper around Amazon's [searchCatalogItems](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference#searchcatalogitems) API", "operationId": "searchCatalogItems", "parameters": [ { "description": "A comma separated list of identifiers. Note that SKUs with commas need to be searched one at a time.", "example": "B001FOQJOG", "in": "query", "name": "identifiers", "schema": { "type": "string" } }, { "description": "[IdentifiersType](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference#identifierstype)", "example": "ASIN", "in": "query", "name": "identifiersType", "schema": { "type": "string" } }, { "example": [ "US" ], "in": "query", "name": "marketplaceIds", "schema": { "items": { "$ref": "#/components/schemas/MarketplaceId" }, "type": "array" } }, { "description": "A comma separated list of one or more [IncludedData](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference#includeddata-subgroup-2), defaults to `summaries`.", "in": "query", "name": "includedData", "schema": { "type": "string" } }, { "in": "query", "name": "locale", "schema": { "type": "string" } }, { "in": "query", "name": "keywords", "schema": { "type": "string" } }, { "in": "query", "name": "brandNames", "schema": { "type": "string" } }, { "in": "query", "name": "classificationIds", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "pageToken", "schema": { "type": "string" } }, { "in": "query", "name": "keywordsLocale", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ItemSearchResults](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference#itemsearchresults)", "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon Catalog" ] } }, "/api/az/inbound/fba/inboundPlans": { "get": { "summary": "List InboundPlans", "description": "Wrapper around Amazon's [listInboundPlans](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listinboundplans) API", "operationId": "listInboundPlans", "parameters": [ { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "description": "[Status](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#status)", "enum": [ "ACTIVE", "VOIDED", "SHIPPED" ], "type": "string" } }, { "in": "query", "name": "sortBy", "schema": { "description": "[SortBy](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#sortby)", "enum": [ "LAST_UPDATED_TIME", "CREATION_TIME" ], "type": "string" } }, { "in": "query", "name": "sortOrder", "schema": { "description": "[SortOrder](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#sortorder)", "enum": [ "ASC", "DESC" ], "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListInboundPlansResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listinboundplansresponse)", "properties": { "inboundPlans": { "items": { "description": "[InboundPlanSummary](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#inboundplansummary)", "properties": { "createdAt": { "type": "string" }, "inboundPlanId": { "type": "string" }, "lastUpdatedAt ": { "type": "string" }, "marketplaceIds": { "items": { "$ref": "#/components/schemas/MarketplaceId" }, "type": "array" }, "name": { "type": "string" }, "sourceAddress": { "$ref": "#/components/schemas/Address" }, "status": { "enum": [ "ACTIVE", "VOIDED", "SHIPPED", "ERRORED" ], "type": "string" } }, "type": "object" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment" ] }, "post": { "summary": "Create Inbound Plan", "description": "Wrapper around Amazon's [createInboundPlan](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#createinboundplan) API", "operationId": "createInboundPlan", "parameters": [ { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[CreateInboundPlanRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#createinboundplanrequest)", "properties": { "destinationMarketplaces": { "items": { "type": "string" }, "type": "array" }, "items": { "items": { "$ref": "#/components/schemas/ItemInput" }, "type": "array" }, "name": { "type": "string" }, "sourceAddress": { "$ref": "#/components/schemas/spapi.AddressInput" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "[CreateInboundPlanResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#createinboundplanresponse)", "properties": { "inboundPlanId": { "type": "string" }, "operationId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}": { "get": { "summary": "Get Inbound Plan", "description": "Wrapper around Amazon's [getInboundPlan](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#getinboundplan) API", "operationId": "getInboundPlan", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[InboundPlan](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#inboundplan)", "properties": { "createdAt": { "type": "string" }, "inboundPlanId": { "type": "string" }, "lastUpdatedAt ": { "type": "string" }, "marketplaceIds": { "items": { "$ref": "#/components/schemas/MarketplaceId" }, "type": "array" }, "name": { "type": "string" }, "packingOptions": { "items": { "description": "[PackingOptionSummary](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#packingoptionsummary)", "properties": { "packingOptionId": { "type": "string" }, "status": { "enum": [ "OFFERED", "ACCEPTED", "EXPIRED" ], "type": "string" } }, "type": "object" }, "type": "array" }, "placementOptions": { "items": { "description": "[PlacementOptionSummary](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#placementoptionsummary)", "properties": { "placementOptionId": { "type": "string" }, "status": { "enum": [ "OFFERED", "ACCEPTED" ], "type": "string" } }, "type": "object" }, "type": "array" }, "shipments": { "items": { "description": "[ShipmentSummary](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#shipmentsummary)", "properties": { "shipmentId": { "type": "string" }, "status": { "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "WORKING" ], "type": "string" } }, "type": "object" }, "type": "array" }, "sourceAddress": { "$ref": "#/components/schemas/Address" }, "status": { "enum": [ "ACTIVE", "VOIDED", "SHIPPED", "ERRORED" ], "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/boxes": { "get": { "summary": "List InboundPlan Boxes", "description": "Wrapper around Amazon's [listInboundPlanBoxes](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listinboundplanboxes) API", "operationId": "listInboundPlanBoxes", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListInboundPlanBoxesResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listinboundplanboxesresponse)", "properties": { "boxes": { "items": { "$ref": "#/components/schemas/Box" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/cancellation": { "put": { "summary": "Cancel InboundPlan", "description": "Wrapper around Amazon's [cancelInboundPlan](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#cancelinboundplan) API", "operationId": "cancelInboundPlan", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "description": "[CancelInboundPlanResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#cancelinboundplanresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/InboundOperationStatus" } ] } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/items": { "get": { "summary": "List InboundPlan Items", "description": "Wrapper around Amazon's [listInboundPlanItems](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listinboundplanitems) API", "operationId": "listInboundPlanItems", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListInboundPlanItemsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listinboundplanitemsresponse)", "properties": { "items": { "items": { "$ref": "#/components/schemas/Item" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/name": { "put": { "summary": "Update InboundPlan Name", "description": "Wrapper around Amazon's [updateInboundPlanName](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#updateinboundplanname) API", "operationId": "updateInboundPlanName", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[UpdateInboundPlanNameRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#updateinboundplannamerequest)", "properties": { "name": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/boxes": { "get": { "summary": "List PackingGroup Boxes", "description": "Wrapper around Amazon's [listPackingGroupBoxes](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listpackinggroupboxes) API", "operationId": "listPackingGroupBoxes", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "packingGroupId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListPackingGroupBoxesResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listpackinggroupboxesresponse)", "properties": { "boxes": { "items": { "$ref": "#/components/schemas/Box" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/items": { "get": { "summary": "List PackingGroup Items", "description": "Wrapper around Amazon's [listPackingGroupItems](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listpackinggroupitems) API", "operationId": "listPackingGroupItems", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "packingGroupId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListPackingGroupItemsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listpackinggroupitemsresponse)", "properties": { "items": { "items": { "$ref": "#/components/schemas/Item" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/packingInformation": { "post": { "summary": "Set Packing Information", "description": "Wrapper around Amazon's [setPackingInformation](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#setpackinginformation) API", "operationId": "setPackingInformation", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[SetPackingInformationRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#setpackinginformationrequest)", "properties": { "packageGroupings": { "items": { "description": "[PackageGroupingInput](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#packagegroupinginput)", "properties": { "boxes": { "items": { "$ref": "#/components/schemas/BoxInput" }, "type": "array" }, "packingGroupId": { "type": "string" }, "shipmentId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "[SetPackingInformationResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#setpackinginformationresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/packingOptions": { "get": { "summary": "List Packing Options", "description": "Wrapper around Amazon's [listPackingOptions](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listpackingoptions) API", "operationId": "listPackingOptions", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListPackingOptionsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listpackingoptionsresponse)", "properties": { "packingOptions": { "items": { "$ref": "#/components/schemas/spapi.PackingOption" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] }, "post": { "summary": "Generate Packing Options", "description": "Wrapper around Amazon's [generatePackingOptions](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generatepackingoptions) API", "operationId": "generatePackingOptions", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/list" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "description": "[GeneratePackingOptionsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generatepackingoptionsresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/InboundOperationStatus" } ] } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/packingOptions/{packingOptionId}/confirmation": { "post": { "summary": "Confirm Packing Option", "description": "Wrapper around Amazon's [confirmPackingOption](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#confirmpackingoption) API", "operationId": "confirmPackingOption", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "packingOptionId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ConfirmPackingOptionResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#confirmpackingoptionresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/pallets": { "get": { "summary": "List InboundPlan Pallets", "description": "Wrapper around Amazon's [listInboundPlanPallets](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listinboundplanpallets) API", "operationId": "listInboundPlanPallets", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListInboundPlanPalletsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listinboundplanpalletsresponse)", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "pallets": { "items": { "$ref": "#/components/schemas/spapi.Pallet" }, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/placementOptions": { "get": { "summary": "List Placement Options", "description": "Wrapper around Amazon's [listPlacementOptions](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listplacementoptions) API", "operationId": "listPlacementOptions", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListPlacementOptionsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listplacementoptionsresponse)", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "placementOptions": { "items": { "$ref": "#/components/schemas/spapi.PlacementOption" }, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] }, "post": { "summary": "Generate Placement Options", "description": "Wrapper around Amazon's [generatePlacementOptions](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generateplacementoptions) API", "operationId": "generatePlacementOptions", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/list" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[GeneratePlacementOptionsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generateplacementoptionsresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/placementOptions/{placementOptionId}/confirmation": { "post": { "summary": "Confirm Placement Option", "description": "Wrapper around Amazon's [confirmPlacementOption](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#confirmplacementoption) API", "operationId": "confirmPlacementOption", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "placementOptionId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ConfirmPlacementOptionResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#confirmplacementoptionresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}": { "get": { "summary": "Get Shipment", "description": "Wrapper around Amazon's [getShipment](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#getshipment) API", "operationId": "getShipment", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/boxes": { "get": { "summary": "List Shipment Boxes", "description": "Wrapper around Amazon's [listShipmentBoxes](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentboxes) API", "operationId": "listShipmentBoxes", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListShipmentBoxesResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentboxesresponse)", "properties": { "boxes": { "items": { "$ref": "#/components/schemas/Box" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews": { "get": { "summary": "List ShipmentContent UpdatePreviews", "description": "Wrapper around Amazon's [listShipmentContentUpdatePreviews](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentcontentupdatepreviews) API", "operationId": "listShipmentContentUpdatePreviews", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListShipmentContentUpdatePreviewsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentcontentupdatepreviewsresponse)", "properties": { "contentUpdatePreviews": { "items": { "description": "[ContentUpdatePreview](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#contentupdatepreview)", "properties": { "contentUpdatePreviewId": { "type": "string" }, "expiration": { "type": "string" }, "requestedUpdates": { "$ref": "#/components/schemas/spapi.RequestedUpdates" }, "transportationOption": { "$ref": "#/components/schemas/TransportationOption" } }, "type": "object" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] }, "post": { "summary": "Generate ShipmentContent UpdatePreviews", "description": "Wrapper around Amazon's [generateShipmentContentUpdatePreviews](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generateshipmentcontentupdatepreviews) API", "operationId": "generateShipmentContentUpdatePreviews", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[GenerateShipmentContentUpdatePreviewsRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generateshipmentcontentupdatepreviewsrequest)", "properties": { "boxes": { "items": { "$ref": "#/components/schemas/BoxUpdateInput" }, "type": "array" }, "items": { "items": { "$ref": "#/components/schemas/ItemInput" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "[GenerateSelfShipAppointmentSlotsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generateselfshipappointmentslotsresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}": { "get": { "summary": "Get ShipmentContent UpdatePreview", "description": "Wrapper around Amazon's [getShipmentContentUpdatePreview](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#getshipmentcontentupdatepreview) API", "operationId": "getShipmentContentUpdatePreview", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "contentUpdatePreviewId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ContentUpdatePreview](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#contentupdatepreview)", "properties": { "contentUpdatePreviewId": { "type": "string" }, "expiration": { "type": "string" }, "requestedUpdates": { "$ref": "#/components/schemas/spapi.RequestedUpdates" }, "transportationOption": { "$ref": "#/components/schemas/TransportationOption" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}/confirmation": { "post": { "summary": "Confirm ShipmentContent UpdatePreview", "description": "Wrapper around Amazon's [confirmShipmentContentUpdatePreview](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#confirmshipmentcontentupdatepreview) API", "operationId": "confirmShipmentContentUpdatePreview", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "contentUpdatePreviewId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ConfirmShipmentContentUpdatePreviewResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#confirmshipmentcontentupdatepreviewresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryChallanDocument": { "get": { "summary": "Get DeliveryChallan Document", "description": "Wrapper around Amazon's [getDeliveryChallanDocument](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#getdeliverychallandocument) API", "operationId": "getDeliveryChallanDocument", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[GetDeliveryChallanDocumentResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#getdeliverychallandocumentresponse)", "properties": { "documentDownload ": { "$ref": "#/components/schemas/spapi.DocumentDownload" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions": { "get": { "summary": "List DeliveryWindow Options", "description": "Wrapper around Amazon's [listDeliveryWindowOptions](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listdeliverywindowoptions) API", "operationId": "listDeliveryWindowOptions", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListDeliveryWindowOptionsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listdeliverywindowoptionsresponse)", "properties": { "deliveryWindowOptions": { "items": { "description": "[DeliveryWindowOption](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#deliverywindowoption)", "properties": { "availabilityType": { "$ref": "#/components/schemas/availabilityType" }, "deliveryWindowOptionId": { "type": "string" }, "endDate": { "type": "string" }, "startDate": { "type": "string" }, "validUntil": { "type": "string" } }, "type": "object" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] }, "post": { "summary": "Generate DeliveryWindow Options", "description": "Wrapper around Amazon's [generateDeliveryWindowOptions](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generatedeliverywindowoptions) API", "operationId": "generateDeliveryWindowOptions", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[GenerateDeliveryWindowOptionsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generatedeliverywindowoptionsresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions/{deliveryWindowOptionId}/confirmation": { "post": { "summary": "Confirm DeliveryWindow Options", "description": "Wrapper around Amazon's [confirmDeliveryWindowOptions](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#confirmdeliverywindowoptions) API", "operationId": "confirmDeliveryWindowOptions", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deliveryWindowOptionId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ConfirmDeliveryWindowOptionsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#confirmdeliverywindowoptionsresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/items": { "get": { "summary": "List ShipmentItems", "description": "Wrapper around Amazon's [listShipmentItems](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentitems) API", "operationId": "listShipmentItems", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListShipmentItemsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentitemsresponse)", "properties": { "items": { "items": { "$ref": "#/components/schemas/Item" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/name": { "put": { "summary": "Update Shipment Name", "description": "Wrapper around Amazon's [updateShipmentName](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#updateshipmentname) API", "operationId": "updateShipmentName", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[UpdateShipmentNameRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#updateshipmentnamerequest)", "properties": { "name": { "type": "string" } }, "type": "object" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/pallets": { "get": { "summary": "List Shipment Pallets", "description": "Wrapper around Amazon's [listShipmentPallets](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentpallets) API", "operationId": "listShipmentPallets", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListShipmentPalletsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentpalletsresponse)", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "pallets": { "items": { "$ref": "#/components/schemas/spapi.Pallet" }, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentCancellation": { "put": { "summary": "Cancel SelfShip Appointment", "description": "Wrapper around Amazon's [cancelSelfShipAppointment](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#cancelselfshipappointment) API", "operationId": "cancelSelfShipAppointment", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[CancelSelfShipAppointmentRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#cancelselfshipappointmentrequest)", "properties": { "reasonComment": { "description": "[ReasonComment](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#reasoncomment)", "enum": [ "APPOINTMENT_REQUESTED_BY_MISTAKE", "VEHICLE_DELAY", "SLOT_NOT_SUITABLE", "OUTSIDE_CARRIER_BUSINESS_HOURS", "UNFAVOURABLE_EXTERNAL_CONDITIONS", "PROCUREMENT_DELAY", "SHIPPING_PLAN_CHANGED", "INCREASED_QUANTITY", "OTHER" ], "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "[CancelSelfShipAppointmentResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#cancelselfshipappointmentresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots": { "get": { "summary": "Get SelfShip Appointment Slots", "description": "Wrapper around Amazon's [getSelfShipAppointmentSlots](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#getselfshipappointmentslots) API", "operationId": "getSelfShipAppointmentSlots", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[GetSelfShipAppointmentSlotsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#getselfshipappointmentslotsresponse)", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "selfShipAppointmentSlotsAvailability": { "description": "[SelfShipAppointmentSlotsAvailability](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#selfshipappointmentslotsavailability)", "properties": { "expiresAt": { "type": "string" }, "slots": { "items": { "description": "[AppointmentSlot](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#appointmentslot)", "properties": { "slotId": { "type": "string" }, "slotTime": { "$ref": "#/components/schemas/spapi.AppointmentSlotTime" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] }, "post": { "summary": "Generate SelfShip Appointment Slots", "description": "Wrapper around Amazon's [generateSelfShipAppointmentSlots](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generateselfshipappointmentslots) API", "operationId": "generateSelfShipAppointmentSlots", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[GenerateSelfShipAppointmentSlotsRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generateselfshipappointmentslotsrequest)", "properties": { "desiredEndDate": { "type": "string" }, "desiredStartDate": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "[GenerateSelfShipAppointmentSlotsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generateselfshipappointmentslotsresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentSlots/{slotId}/schedule": { "post": { "summary": "Schedule SelfShip Appointment", "description": "Wrapper around Amazon's [scheduleSelfShipAppointment](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#scheduleselfshipappointment) API", "operationId": "scheduleSelfShipAppointment", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "slotId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[ScheduleSelfShipAppointmentRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#scheduleselfshipappointmentrequest)", "properties": { "reasonComment": { "description": "[ReasonComment](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#reasoncomment)", "enum": [ "APPOINTMENT_REQUESTED_BY_MISTAKE", "VEHICLE_DELAY", "SLOT_NOT_SUITABLE", "OUTSIDE_CARRIER_BUSINESS_HOURS", "UNFAVOURABLE_EXTERNAL_CONDITIONS", "PROCUREMENT_DELAY", "SHIPPING_PLAN_CHANGED", "INCREASED_QUANTITY", "OTHER" ], "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ScheduleSelfShipAppointmentResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#scheduleselfshipappointmentresponse)", "properties": { "selfShipAppointmentDetails": { "description": "[SelfShipAppointmentDetails](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#selfshipappointmentdetails)", "properties": { "appointmentId": { "type": "integer" }, "appointmentSlotTime": { "$ref": "#/components/schemas/spapi.AppointmentSlotTime" }, "appointmentStatus": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/sourceAddress": { "put": { "summary": "Update ShipmentSource Address", "description": "Wrapper around Amazon's [updateShipmentSourceAddress](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#updateshipmentsourceaddress) API", "operationId": "updateShipmentSourceAddress", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "description": "[UpdateShipmentSourceAddressRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#updateshipmentsourceaddressrequest)", "properties": { "address": { "$ref": "#/components/schemas/spapi.AddressInput" } }, "type": "object" }, { "properties": { "source_id": { "description": "A ScanPower source/ship-from id", "type": "integer" } }, "type": "object" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "description": "[UpdateShipmentSourceAddressResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#updateshipmentsourceaddressresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/InboundOperationStatus" } ] } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/trackingDetails": { "put": { "summary": "Update Shipment TrackingDetails", "description": "Wrapper around Amazon's [updateShipmentTrackingDetails](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#updateshipmenttrackingdetails) API", "operationId": "updateShipmentTrackingDetails", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[UpdateShipmentTrackingDetailsRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#updateshipmenttrackingdetailsrequest)", "properties": { "trackingDetails": { "description": "[TrackingDetailsInput](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#trackingdetailsinput)", "properties": { "ltlTrackingDetail": { "description": "[LtlTrackingDetailInput](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#ltltrackingdetailinput)", "properties": { "billOfLadingNumber": { "type": "string" }, "freightBillNumber": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "spdTrackingDetail": { "description": "[SpdTrackingDetailInput](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#spdtrackingdetailinput)", "properties": { "spdTrackingItems": { "items": { "description": "[SpdTrackingItemInput](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#spdtrackingiteminput)", "properties": { "boxId": { "type": "string" }, "trackingId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "description": "[UpdateShipmentTrackingDetailsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#updateshipmenttrackingdetailsresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/InboundOperationStatus" } ] } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/transportationOptions": { "get": { "summary": "List Transportation Options", "description": "Wrapper around Amazon's [listTransportationOptions](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listtransportationoptions) API", "operationId": "listTransportationOptions", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/spapi.pageSize" }, { "in": "query", "name": "paginationToken", "schema": { "type": "string" } }, { "in": "query", "name": "placementOptionId", "schema": { "type": "string" } }, { "in": "query", "name": "shipmentId", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/allPages" }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListTransportationOptionsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listtransportationoptionsresponse)", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "transportationOptions": { "items": { "$ref": "#/components/schemas/TransportationOption" }, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] }, "post": { "summary": "Generate Transportation Options", "description": "Wrapper around Amazon's [generateTransportationOptions](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generatetransportationoptions) API", "operationId": "generateTransportationOptions", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/list" }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[GenerateTransportationOptionsRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generatetransportationoptionsrequest)", "properties": { "placementOptionId": { "type": "string" }, "shipmentTransportationConfigurations": { "items": { "description": "[ShipmentTransportationConfiguration](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#shipmenttransportationconfiguration)", "properties": { "contactInformation": { "$ref": "#/components/schemas/ContactInformation" }, "freightInformation": { "$ref": "#/components/schemas/FreightInformation" }, "pallets": { "items": { "description": "[PalletInput](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#palletinput)", "properties": { "dimensions": { "$ref": "#/components/schemas/Dimensions" }, "quantity": { "type": "integer" }, "stackability": { "$ref": "#/components/schemas/Stackability" }, "weight ": { "$ref": "#/components/schemas/Weight" } }, "type": "object" }, "type": "array" }, "readyToShipWindow": { "description": "[WindowInput](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#windowinput)", "properties": { "start": { "type": "string" } }, "type": "object" }, "shipmentId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "[GenerateTransportationOptionsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#generatetransportationoptionsresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/inboundPlans/{inboundPlanId}/transportationOptions/confirmation": { "post": { "summary": "Confirm Transportation Options", "description": "Wrapper around Amazon's [confirmTransportationOptions](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#confirmtransportationoptions) API", "operationId": "confirmTransportationOptions", "parameters": [ { "in": "path", "name": "inboundPlanId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[ConfirmTransportationOptionsRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#confirmtransportationoptionsrequest)", "properties": { "transportationSelections ": { "items": { "description": "[TransportationSelection](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#transportationselection)", "properties": { "contactInformation": { "$ref": "#/components/schemas/ContactInformation" }, "shipmentId": { "type": "string" }, "transportationOptionId": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ConfirmTransportationOptionsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#confirmtransportationoptionsresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/items/compliance": { "get": { "summary": "List ItemCompliance Details", "description": "Wrapper around Amazon's [listItemComplianceDetails](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listitemcompliancedetails) API", "operationId": "listItemComplianceDetails", "parameters": [ { "in": "query", "name": "mskus", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "marketplaceId", "required": true, "schema": { "$ref": "#/components/schemas/MarketplaceId" } }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListItemComplianceDetailsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listitemcompliancedetailsresponse)", "properties": { "complianceDetails": { "items": { "description": "[ComplianceDetail](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#compliancedetail)", "properties": { "asin": { "type": "string" }, "fnsku": { "type": "string" }, "msku": { "type": "string" }, "taxDetails": { "$ref": "#/components/schemas/spapi.TaxDetails" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] }, "put": { "summary": "Update ItemCompliance Details", "description": "Wrapper around Amazon's [updateItemComplianceDetails](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#updateitemcompliancedetails) API", "operationId": "updateItemComplianceDetails", "parameters": [ { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[UpdateItemComplianceDetailsRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#updateitemcompliancedetailsrequest)", "properties": { "msku": { "type": "string" }, "taxDetails": { "$ref": "#/components/schemas/spapi.TaxDetails" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "description": "[UpdateItemComplianceDetailsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#updateitemcompliancedetailsresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/InboundOperationStatus" } ] } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/items/labels": { "post": { "summary": "Create Marketplace ItemLabels", "description": "Wrapper around Amazon's [createMarketplaceItemLabels](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#createmarketplaceitemlabels) API", "operationId": "createMarketplaceItemLabels", "parameters": [ { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[CreateMarketplaceItemLabelsRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#createmarketplaceitemlabelsrequest)", "properties": { "height": { "type": "integer" }, "labelType": { "description": "[LabelPrintType](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#labelprinttype)", "enum": [ "STANDARD_FORMAT", "THERMAL_PRINTING" ], "type": "string" }, "localeCode": { "type": "string" }, "marketplaceId": { "$ref": "#/components/schemas/MarketplaceId" }, "mskuQuantities": { "items": { "description": "[MskuQuantity](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#mskuquantity)", "properties": { "msku": { "type": "string" }, "quantity": { "type": "integer" } }, "type": "object" }, "type": "array" }, "pageType": { "description": "[ItemLabelPageType](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#itemlabelpagetype)", "enum": [ "A4_21", "A4_24", "A4_24_64x33", "A4_24_66x35", "A4_24_70x36", "A4_24_70x37", "A4_24i", "A4_27", "A4_40_52x29", "A4_44_48x25", "Letter_30" ], "type": "string" }, "width": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "[CreateMarketplaceItemLabelsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#createmarketplaceitemlabelsresponse)", "properties": { "documentDownloads": { "items": { "$ref": "#/components/schemas/spapi.DocumentDownload" }, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment", "Printing" ] } }, "/api/az/inbound/fba/items/prepDetails": { "get": { "summary": "List Prep Details", "description": "Wrapper around Amazon's [listPrepDetails](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listprepdetails) API", "operationId": "listPrepDetails", "parameters": [ { "in": "query", "name": "marketplaceId", "required": true, "schema": { "$ref": "#/components/schemas/MarketplaceId" } }, { "in": "query", "name": "mskus", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[ListPrepDetailsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listprepdetailsresponse)", "properties": { "mskuPrepDetails": { "items": { "description": "[MskuPrepDetail](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#mskuprepdetail)", "properties": { "allOwnersConstraint": { "description": "[AllOwnersConstraint](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#allownersconstraint)", "enum": [ "MUST_MATCH" ], "type": "string" }, "labelOwnerConstraint": { "$ref": "#/components/schemas/spapi.OwnerConstraint" }, "msku": { "type": "string" }, "prepCategory": { "$ref": "#/components/schemas/spapi.PrepCategory" }, "prepOwnerConstraint": { "$ref": "#/components/schemas/spapi.OwnerConstraint" }, "prepTypes": { "items": { "$ref": "#/components/schemas/spapi.PrepType" }, "type": "array" } }, "required": [ "msku", "prepCategory", "prepTypes" ], "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] }, "post": { "summary": "Set Prep Details", "description": "Wrapper around Amazon's [setPrepDetails](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#setprepdetails) API", "operationId": "setPrepDetails", "parameters": [ { "$ref": "#/components/parameters/operationComplete" }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "[SetPrepDetailsRequest](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#setprepdetailsrequest)", "properties": { "marketplaceId": { "$ref": "#/components/schemas/MarketplaceId" }, "mskuPrepDetails": { "items": { "description": "[MskuPrepDetailInput](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#mskuprepdetailinput)", "properties": { "msku": { "type": "string" }, "prepCategory": { "$ref": "#/components/schemas/spapi.PrepCategory" }, "prepTypes": { "items": { "$ref": "#/components/schemas/spapi.PrepType" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "description": "[SetPrepDetailsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#setprepdetailsresponse)", "properties": { "operationId": { "type": "string" } }, "type": "object" }, { "$ref": "#/components/schemas/InboundOperationStatus" } ] } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/operations/{operationId}": { "get": { "summary": "Get InboundOperation Status", "description": "Wrapper around Amazon's [getInboundOperationStatus](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#getinboundoperationstatus) API", "operationId": "getInboundOperationStatus", "parameters": [ { "in": "path", "name": "operationId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboundOperationStatus" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/shipments/{shipmentId}/billOfLading": { "get": { "summary": "Get BillOfLading", "description": "Wrapper around Amazon's [getBillOfLading](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v0-reference#getbilloflading) API", "operationId": "getBillOfLading", "parameters": [ { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[GetBillOfLadingResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v0-reference#getbillofladingresponse)", "properties": { "errors": { "description": "[ErrorList](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v0-reference#errorlist)", "items": { "$ref": "#/components/schemas/spapi.Error" }, "type": "array" }, "payload": { "description": "[BillOfLadingDownloadURL](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v0-reference#billofladingdownloadurl)", "properties": { "DownloadURL": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/az/inbound/fba/shipments/{shipmentId}/labels": { "get": { "summary": "Get Labels", "description": "Wrapper around Amazon's [getLabels](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v0-reference#getlabels) API", "operationId": "getLabels", "parameters": [ { "in": "path", "name": "shipmentId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "PageType", "required": true, "schema": { "description": "[PageType](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v0-reference#pagetype)", "enum": [ "PackageLabel_A4_2_DHL", "PackageLabel_Letter_PCP_FulfillmentLabel", "PackageLabel_AWD_Thermal_Square_10CM", "PackageLabel_Letter_6_Unified", "PackageLabel_A4_2_CITITRANS", "PackageLabel_Thermal", "PackageLabel_Plain_Paper", "PackageLabel_A4_2_AMZL", "PackageLabel_AWD_Letter_2_Horizontal", "PackageLabel_Plain_Paper_Default", "PackageLabel_Thermal_NonPCP", "PackageLabel_Plain_Paper_ARAMEX", "PackageLabel_A4_2_AIDUK", "PackageLabel_Thermal_No_Carrier_Rotation", "PackageLabel_Plain_Paper_CarrierBottom", "PackageLabel_Letter_2", "PackageLabel_A4_2_Horizontal", "PackageLabel_Thermal_No_Carrier_Rotation_SEND_CN_Carriers", "PackageLabel_Letter_2_SEND_CN_Carriers", "PackageLabel_Letter_6_CarrierLeft", "PackageLabel_Letter_6", "PackageLabel_AWD_Letter_PCP_FulfillmentLabel", "PackageLabel_Thermal_Square_10CM", "PackageLabel_A4_6_ARAMEX", "PackageLabel_AWD_Plain_Paper", "PackageLabel_AWD_Thermal", "PackageLabel_A4_2", "PackageLabel_A4_2_GIFT", "PackageLabel_AWD_Thermal_No_Carrier_Rotation", "PackageLabel_Thermal_Unified", "PackageLabel_Plain_Paper_Unified", "PackageLabel_Letter_2_Horizontal", "PackageLabel_A4_4", "PackageLabel_AWD_Thermal_NonPCP", "PackageLabel_AWD_A4_2_Horizontal", "PackageLabel_AWD_Letter_2", "PackageLabel_A4_6", "PackageLabel_A4_2_Standard_Carrier", "PackageLabel_AWD_Letter_6", "PackageLabel_A4_2_YAMATO", "PackageLabel_Plain_Paper_JPPost" ], "type": "string" } }, { "in": "query", "name": "LabelType", "required": true, "schema": { "description": "[LabelType](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v0-reference#labeltype)", "enum": [ "BARCODE_2D", "UNIQUE", "PALLET" ], "type": "string" } }, { "in": "query", "name": "NumberOfPackages", "schema": { "type": "integer" } }, { "in": "query", "name": "PackageLabelsToPrint ", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "NumberOfPallets", "schema": { "type": "integer" } }, { "in": "query", "name": "PageSize", "schema": { "type": "integer" } }, { "in": "query", "name": "PageStartIndex", "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "[GetLabelsResponse](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v0-reference#getlabelsresponse)", "properties": { "errors": { "description": "[ErrorList](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v0-reference#errorlist)", "items": { "$ref": "#/components/schemas/spapi.Error" }, "type": "array" }, "payload": { "description": "[LabelDownloadURL](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v0-reference#labeldownloadurl)", "properties": { "DownloadURL": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment", "Printing" ] } }, "/api/batch/{batch_id}/inbound_plan": { "get": { "summary": "Get InboundPlans", "description": "Load the inbound plans associated with the given batch", "operationId": "getInboundPlans", "parameters": [ { "in": "path", "name": "batch_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "inbound_plans": { "items": { "$ref": "#/components/schemas/inbound_plan" }, "type": "array" }, "total_rows": { "description": "The total number of plans that could be returned", "type": "integer" } }, "type": "object" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment", "Amazon Batch" ] }, "post": { "summary": "Create an inbound plan from the items in the provided batch", "description": "Create an inbound plan from the items in the provided batch", "operationId": "createInboundPlanFromBatch", "parameters": [ { "in": "path", "name": "batch_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/error" }, "type": "array" }, "inbound_plan": { "$ref": "#/components/schemas/inbound_plan" } }, "type": "object" } } }, "description": "Plan data will be returned if it takes less than 5 seconds to generate." }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment", "Amazon Batch" ] } }, "/api/batch/{batch_id}/submit_boxes": { "post": { "summary": "Submit Boxes", "description": "Send packed box information to Amazon", "operationId": "submitBoxes", "parameters": [ { "in": "path", "name": "batch_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/error" }, "type": "array" }, "placement_options": { "items": { "$ref": "#/components/schemas/placement_option" }, "type": "array" } }, "type": "object" } } }, "description": "Placement options will be returned if it takes less than 5 seconds to generate." }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "FBA Inbound Shipment" ] } }, "/api/scout/search/{query}": { "get": { "summary": "Wrapper around several SP-API calls for loading product, offers, and pricing data.", "description": "This is a wrapper around several SP-API calls for loading product, offers, and pricing data.", "operationId": "scoutSearch", "parameters": [ { "in": "path", "name": "query", "required": true, "schema": { "type": "string" } }, { "description": "Specific marketplace of the requested shipments. Defaults to current marketplace set in ScanPower.", "in": "query", "name": "marketplace", "schema": { "type": "string" } }, { "allowEmptyValue": true, "description": "Load pricing data", "in": "query", "name": "pricing", "schema": {}, "x-isFlag": true }, { "allowEmptyValue": true, "description": "Load offers", "in": "query", "name": "offers", "schema": {}, "x-isFlag": true }, { "allowEmptyValue": true, "description": "Load parent ASIN data, if any", "in": "query", "name": "parent", "schema": {}, "x-isFlag": true }, { "$ref": "#/components/parameters/x-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "items": { "items": { "properties": { "item": { "description": "[Item](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-reference#item)", "type": "object" }, "marketplace": { "type": "string" }, "offers": { "properties": { "Club": { "description": "[GetOffersResult](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference#getoffersresult)", "type": "object" }, "Collectible": { "description": "[GetOffersResult](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference#getoffersresult)", "type": "object" }, "New": { "description": "[GetOffersResult](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference#getoffersresult)", "type": "object" }, "Refurbished": { "description": "[GetOffersResult](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference#getoffersresult)", "type": "object" }, "Used": { "description": "[GetOffersResult](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference#getoffersresult)", "type": "object" } }, "type": "object" }, "pricing": { "description": "[Price](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v0-reference#price)", "type": "object" }, "sizeTier": { "type": "string" }, "storageFee": { "properties": { "Amount": { "type": "integer" }, "CurrencyCode": { "type": "string" } }, "type": "object" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon Catalog", "Mobile" ] } }, "/api/v2/box": { "get": { "description": "List boxes for a v1 Amazon batch", "operationId": "selectBoxes", "parameters": [ { "description": "The id of the v1 batch to load boxes for", "in": "query", "name": "v1_batch_id", "schema": { "type": "string" } }, { "description": "The id of the v2 batch to load boxes for", "in": "query", "name": "v2_batch_id", "schema": { "type": "string" } }, { "description": "The id of the v2 shipment to load boxes for", "in": "query", "name": "shipment_id", "schema": { "type": "string" } }, { "description": "Comma separated list of zero or more of `configuration` or `box_items`.", "explode": false, "in": "query", "name": "with", "schema": { "items": { "enum": [ "configuration", "box_items" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "boxes": { "items": { "allOf": [ { "properties": { "box_items": { "items": { "$ref": "#/components/schemas/box_item" }, "type": "array" }, "configuration": { "description": "Boxes sharing the same `configuration` have the same dimensions and items and can be rolled up into a single box with multiple quantity when calling `setPackingInformation`. This number isn't guaranteed to be in any particular order or stay the same across calls.", "type": "integer" } }, "type": "object" }, { "$ref": "#/components/schemas/box" } ] }, "type": "array" }, "total_rows": { "description": "The total number of box records", "format": "int64", "type": "integer" } }, "type": "object" } } }, "description": "Success" }, "204": { "description": "No boxes were found" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "List boxes for a v1 Amazon batch" }, "post": { "description": "Insert a Box", "operationId": "insertBox", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "description": "One of `v1_batch_id`, `v2_batch_id`, or `shipment_id` is required.", "properties": { "shipment_id": { "description": "The shipment to create the box in", "type": "string" }, "v1_batch_id": { "description": "The v1 batch to create the box in", "type": "integer" }, "v2_batch_id": { "description": "The v2 batch to create the box in", "format": "int64", "type": "integer" } }, "type": "object" }, { "$ref": "#/components/schemas/box_input" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "box": { "$ref": "#/components/schemas/box" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Insert a Box" } }, "/api/v2/box/{box_id}": { "delete": { "description": "Delete a Box", "operationId": "deleteBox", "parameters": [ { "description": "The id of the box to delete", "in": "path", "name": "box_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "box": { "$ref": "#/components/schemas/box" } }, "type": "object" } } }, "description": "Sucess" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Delete a Box" }, "get": { "description": "Get a Box", "operationId": "selectBox", "parameters": [ { "description": "The id of the box to get", "in": "path", "name": "box_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "box": { "$ref": "#/components/schemas/box" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Get a Box" }, "patch": { "description": "Update Box", "operationId": "updateBox", "parameters": [ { "description": "The id of the box to update", "in": "path", "name": "box_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/box_input" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "box": { "$ref": "#/components/schemas/box" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Delete Box" } }, "/api/v2/box/{box_id}/items": { "get": { "description": "List BoxItems", "operationId": "selectBoxItems", "parameters": [ { "description": "The id of the box to get", "in": "path", "name": "box_id", "required": true, "schema": { "type": "string" } }, { "description": "The timestamp the box with ID `box_id` was created", "in": "query", "name": "box_created", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "box_items": { "items": { "$ref": "#/components/schemas/box_item" }, "type": "array" }, "total_rows": { "type": "integer" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "List BoxItems" }, "post": { "description": "Insert BoxItem", "operationId": "insertBoxItem", "parameters": [ { "description": "The id of the box to get", "in": "path", "name": "box_id", "required": true, "schema": { "type": "string" } }, { "description": "The timestamp the box with ID `box_id` was created", "in": "query", "name": "box_created", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "sku": { "type": "string" }, "external_id": { "type": "string" } }, "required": [ "sku", "external_id" ], "type": "object" }, { "$ref": "#/components/schemas/box_item_input" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "box_item": { "$ref": "#/components/schemas/box_item" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Insert BoxItem" } }, "/api/v2/box/{box_id}/items/{sku}": { "delete": { "description": "Delete BoxItem", "operationId": "deleteBoxItem", "parameters": [ { "description": "The id of the box in which the item to delete resides", "in": "path", "name": "box_id", "required": true, "schema": { "type": "string" } }, { "description": "The SKU of the box item to delete", "in": "path", "name": "sku", "required": true, "schema": { "type": "string" } }, { "description": "The timestamp the box with ID `box_id` was created", "in": "query", "name": "box_created", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "box_item": { "$ref": "#/components/schemas/box_item" } }, "type": "object" } } }, "description": "Sucess" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Delete BoxItem" }, "patch": { "description": "Update BoxItem", "operationId": "updateBoxItem", "parameters": [ { "description": "The id of the box in which the item to update resides", "in": "path", "name": "box_id", "required": true, "schema": { "type": "string" } }, { "description": "The SKU of the box item to update", "in": "path", "name": "sku", "required": true, "schema": { "type": "string" } }, { "description": "The timestamp the box with ID `box_id` was created", "in": "query", "name": "box_created", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/box_item_input" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "box_item": { "$ref": "#/components/schemas/box_item" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Update BoxItem" } }, "/api/v2/pallet": { "get": { "description": "List Pallets", "operationId": "selectPallets", "parameters": [ { "description": "The id of the v1 batch to load pallets for", "in": "query", "name": "v1_batch_id", "schema": { "type": "string" } }, { "description": "The id of the v2 batch to load pallets for", "in": "query", "name": "v2_batch_id", "schema": { "type": "string" } }, { "description": "The id of the v2 shipment to load pallets for", "in": "query", "name": "shipment_id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "boxes": { "items": { "$ref": "#/components/schemas/pallet" }, "type": "array" }, "total_rows": { "description": "The total number of pallet records", "format": "int64", "type": "integer" } }, "type": "object" } } }, "description": "Success" }, "204": { "description": "No pallets were found" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "List Pallets" }, "post": { "description": "Insert Pallet", "operationId": "insertPallet", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "description": "One of `v1_batch_id`, `v2_batch_id`, or `shipment_id` is required.", "properties": { "shipment_id": { "description": "The shipment to create the pallet in", "type": "string" }, "v1_batch_id": { "description": "The v1 batch to create the pallet in", "type": "integer" }, "v2_batch_id": { "description": "The v2 batch to create the pallet in", "format": "int64", "type": "integer" } }, "type": "object" }, { "$ref": "#/components/schemas/pallet_input" } ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "pallet": { "$ref": "#/components/schemas/pallet" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Insert Pallet" } }, "/inventory/mobile": { "get": { "description": "Returns found inventory and buylist quantities from the database grouped by condition", "operationId": "getMobileInventory", "parameters": [ { "description": "The ASIN to get data for", "in": "query", "name": "asin", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "additionalProperties": { "type": "object", "properties": { "condition": { "type": "string" }, "instock-quantity": { "type": "integer" }, "inbound-quantity": { "type": "integer" }, "transfer-quantity": { "type": "integer" }, "batch-quantity": { "type": "integer" }, "listed-quantity": { "type": "integer" }, "purchased-quantity": { "type": "integer" }, "purchased": { "type": "string" }, "cost": { "type": "integer" }, "source._id": { "type": "integer" }, "source": { "type": "string" } } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Mobile" ], "summary": "Returns found Inventory and Buylist quantities from the database grouped by Condition" } }, "/api/v2/pallet/{pallet_id}": { "delete": { "description": "Delete Pallet", "operationId": "deletePallet", "parameters": [ { "description": "The id of the pallet to delete", "in": "path", "name": "pallet_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "pallet": { "$ref": "#/components/schemas/pallet" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Delete Pallet" }, "get": { "description": "List Pallet", "operationId": "selectPallet", "parameters": [ { "description": "The id of the pallet to get", "in": "path", "name": "pallet_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "pallet": { "$ref": "#/components/schemas/pallet" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "List Pallet" }, "patch": { "description": "Update Pallet", "operationId": "updatePallet", "parameters": [ { "description": "The id of the pallet to update", "in": "path", "name": "pallet_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pallet_input" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "pallet": { "$ref": "#/components/schemas/pallet" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Update Pallet" } }, "/graphql?op=PurchaseOrders": { "post": { "description": "Get a list of Purchase Orders.", "operationId": "PurchaseOrders", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nquery PurchaseOrders(\n $marketplace: String,\n $archived: Boolean,\n $deleted: Boolean,\n $search: [String],\n $ship_from: [ID],\n $received: Boolean,\n $can_add_to_batch: Boolean,\n $has_unreceived: Boolean,\n $purchase_order_id: ID,\n $external_id: String,\n $shipment_ids: [ID],\n) {\n purchaseOrders(\n marketplace: $marketplace\n archived: $archived\n deleted: $deleted\n search: $search\n ship_from: $ship_from\n received: $received\n can_add_to_batch: $can_add_to_batch\n has_unreceived: $has_unreceived\n purchase_order_id: $purchase_order_id\n external_id: $external_id\n shipment_ids: $shipment_ids,\n ) {\n _id\n external_id\n name\n ship_from_id\n ship_from\n created\n deleted\n archived\n total_count\n total_ordered\n total_received\n total_shipped\n }\n}\n```", "type": "string" }, "variables": { "properties": { "archived": { "type": "boolean" }, "external_id": { "type": "string", "description": "Find a purchase order by a previously provided `external_id`" }, "marketplace": { "type": "string" }, "search": { "items": { "type": "string" }, "type": "array" }, "ship_from": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "purchaseOrders": { "items": { "type": "object", "description": "The data returned will be in the same shape as the request body" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon", "Prep Center" ], "summary": "Get a list of Purchase Orders." } }, "/graphql?op=CreatePurchaseOrder": { "post": { "description": "Create a single purchase order.", "operationId": "CreatePurchaseOrder", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nmutation CreatePurchaseOrder(\n $ship_from: ID!,\n $marketplace: String!,\n $name: String,\n $external_id: String,\n) {\n createPurchaseOrder(\n ship_from: $ship_from\n marketplace: $marketplace\n name: $name\n external_id: $external_id\n ) {\n _id\n external_id\n name\n ship_from_id\n ship_from\n created\n deleted\n archived\n }\n}\n```", "type": "string" }, "variables": { "properties": { "name": { "type": "string" }, "external_id": { "type": "string", "description": "Optional custom identifier" }, "marketplace": { "type": "string" }, "ship_from": { "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "createPurchaseOrder": { "items": { "type": "object", "description": "The data returned will be in the same shape as the request body" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon", "Prep Center" ], "summary": "Create a single purchase order." } }, "/graphql?op=UpdatePurchaseOrder": { "post": { "description": "Update a purchase order. This does not change any of the items in the PO.", "operationId": "UpdatePurchaseOrder", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nmutation UpdatePurchaseOrder(\n $purchase_order_id: ID!,\n $ship_from: ID,\n $name: String,\n $external_id: String,\n $archived: Boolean,\n $deleted: Boolean\n) {\n updatePurchaseOrder(\n purchase_order_id: $purchase_order_id\n ship_from: $ship_from\n name: $name\n external_id: $external_id\n archived: $archived\n deleted: $deleted\n ) {\n _id\n external_id\n name\n ship_from_id\n ship_from\n created\n deleted\n archived\n }\n}\n```", "type": "string" }, "variables": { "properties": { "purchase_order_id": { "type": "string" }, "name": { "type": "string", "description": "Rename the PO" }, "archived": { "type": "boolean", "description": "Archive or Unarchive the PO" }, "external_id": { "type": "string", "description": "Optional custom identifier" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "updatePurchaseOrder": { "items": { "type": "object", "description": "The data returned will be in the same shape as the request body" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon", "Prep Center" ], "summary": "Update a purchase order. This does not change any of the items in the PO." } }, "/graphql?op=PurchaseOrderItems": { "post": { "description": "Get a list of purchase order items.", "operationId": "PurchaseOrderItems", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nquery PurchaseOrderItems(\n $purchase_order_ids: [ID],\n $search: String,\n $received: Boolean,\n $can_add_to_batch: Boolean,\n $ship_from: [ID]\n) {\n purchaseOrderItems(\n purchase_order_ids: $purchase_order_ids\n search: $search\n received: $received\n can_add_to_batch: $can_add_to_batch\n ship_from: $ship_from\n ) {\n _id\n purchase_order_id\n inventory_id\n inventory {\n msku\n condition\n fnsku\n price\n product {\n asin\n title\n image\n misc\n rank\n upc\n group\n marketplace\n expiration_required\n mapping {\n _id\n upc\n name\n products {\n _id\n quantity\n product {\n _id\n asin\n }\n }\n }\n }\n }\n ordered\n received\n in_batch\n damaged\n missing\n notes\n multipack\n created\n updated\n deleted\n cost\n expires\n batch_items {\n _id\n quantity\n shipments {\n id\n cp\n fcid\n prep\n quantity\n status\n }\n }\n }\n}\n```", "type": "string" }, "variables": { "properties": { "purchase_order_ids": { "type": "array", "items": { "type": "string" } } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "purchaseOrderItems": { "items": { "type": "object", "description": "The data returned will be in the same shape as the request body" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon", "Prep Center" ], "summary": "Get a list of purchase order items." } }, "/graphql?op=CreatePurchaseOrderItems": { "post": { "description": "Add items to a purchase order.", "operationId": "CreatePurchaseOrderItems", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nmutation CreatePurchaseOrderItems(\n $purchase_order_id: ID!,\n $items: [PurchaseOrderItemInput!]\n) {\n createPurchaseOrderItems(\n purchase_order_id: $purchase_order_id,\n items: $items\n ) {\n _id\n purchase_order_id\n inventory_id\n inventory {\n msku\n condition\n fnsku\n price\n product {\n asin\n title\n image\n misc\n rank\n upc\n group\n marketplace\n expiration_required\n mapping {\n _id\n upc\n name\n products {\n _id\n quantity\n product {\n _id\n asin\n }\n }\n }\n }\n }\n ordered\n received\n in_batch\n damaged\n missing\n notes\n multipack\n created\n updated\n deleted\n cost\n expires\n batch_items {\n _id\n quantity\n shipments {\n id\n cp\n fcid\n prep\n quantity\n status\n }\n }\n }\n}\n```", "type": "string" }, "variables": { "properties": { "purchase_order_id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "inventory": { "type": "object", "properties": { "msku": { "type": "string" }, "product": { "type": "object", "properties": { "asin": { "type": "string" } } }, "condition": { "type": "string" }, "marketplace": { "type": "string" } } }, "ordered": { "type": "number", "description": "The quantity of this item that have been ordered" } } } } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "createPurchaseOrderItems": { "items": { "type": "object", "description": "The data returned will be in the same shape as the request body" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon", "Prep Center" ], "summary": "Add items to a purchase order." } }, "/graphql?op=UpdatePurchaseOrderItem": { "post": { "description": "Update a single purchase order item.", "operationId": "UpdatePurchaseOrderItem", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nmutation UpdatePurchaseOrderItem(\n $purchase_order_item_id: ID!,\n $item: PurchaseOrderItemInput!\n) {\n updatePurchaseOrderItem(\n purchase_order_item_id: $purchase_order_item_id\n item: $item\n ) {\n _id\n purchase_order_id\n inventory_id\n inventory {\n msku\n condition\n fnsku\n price\n product {\n asin\n title\n image\n misc\n rank\n upc\n group\n marketplace\n expiration_required\n mapping {\n _id\n upc\n name\n products {\n _id\n quantity\n product {\n _id\n asin\n }\n }\n }\n }\n }\n ordered\n received\n in_batch\n damaged\n missing\n notes\n multipack\n created\n updated\n deleted\n cost\n expires\n batch_items {\n _id\n quantity\n shipments {\n id\n cp\n fcid\n prep\n quantity\n status\n }\n }\n }\n}\n```", "type": "string" }, "variables": { "properties": { "purchase_order_item_id": { "type": "string" }, "item": { "type": "object", "properties": { "inventory": { "type": "object", "properties": { "msku": { "type": "string" }, "product": { "type": "object", "properties": { "asin": { "type": "string" } } }, "condition": { "type": "string" }, "marketplace": { "type": "string" }, "price": { "type": "number", "description": "The price of this item in cents (eg. $5.00 is `500`)" } } }, "ordered": { "type": "number", "description": "The quantity of this item that have been ordered" }, "received": { "type": "number", "description": "The quantity of this item that have been received" }, "damaged": { "type": "number", "description": "The quantity of this item that have been damaged" }, "multipack": { "type": "number" }, "cost": { "type": "number", "description": "The cost of this item in cents (eg. $5.00 is `500`)" }, "expires": { "type": "string", "description": "The expiration date of this item." } } } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "updatePurchaseOrderItem": { "items": { "type": "object", "description": "The data returned will be in the same shape as the request body" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon", "Prep Center" ], "summary": "Update a single purchase order item." } }, "/graphql?op=Batches": { "post": { "summary": "Get Batches", "description": "Get Batches", "operationId": "Batches", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nquery Batches(\n $marketplace: String\n $archived: Boolean\n $deleted: Boolean\n $search: [String]\n $ship_from: [ID]\n $batch_id: ID\n $purchase_order_id: ID\n $limit: Int\n) {\n batches(\n marketplace: $marketplace\n archived: $archived\n deleted: $deleted\n search: $search\n ship_from:$ship_from\n batch_id: $batch_id\n purchase_order_id: $purchase_order_id\n limit: $limit\n ) {\n _id\n name\n marketplace\n ship_from_id\n ship_from\n fba\n multipack\n created\n archived\n deleted\n tags {\n _id\n name\n color\n }\n total_quantity\n total_count\n shipments\n purchase_order_id\n }\n}\n```", "type": "string" }, "variables": { "properties": { "archived": { "type": "boolean" }, "batch_id": { "type": "string" }, "deleted": { "type": "boolean" }, "limit": { "type": "integer" }, "marketplace": { "type": "string" }, "purchase_order_id": { "type": "string" }, "search": { "items": { "type": "string" }, "type": "array" }, "ship_from": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "batches": { "items": { "$ref": "#/components/schemas/batch" }, "type": "array" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ] } }, "/graphql?op=CreateBatch": { "post": { "description": "Create Batch", "operationId": "CreateBatch", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nmutation CreateBatch(\n $ship_from: ID!,\n $marketplace: String!,\n $name: String,\n $tags: [TagInput]\n) {\n createBatch(\n ship_from: $ship_from,\n marketplace: $marketplace,\n name: $name,\n tags: $tags\n ) {\n _id\n name\n marketplace\n ship_from_id\n ship_from\n fba\n multipack\n created\n archived\n deleted\n tags {\n _id\n name\n color\n }\n total_quantity\n total_count\n shipments\n purchase_order_id\n }\n}\n```", "type": "string" }, "variables": { "properties": { "marketplace": { "type": "string" }, "name": { "type": "string" }, "ship_from": { "type": "string" }, "tags": { "items": { "$ref": "#/components/schemas/tag" }, "type": "array" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "createBatch": { "$ref": "#/components/schemas/batch" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Create Batch" } }, "/graphql?op=UpdateBatch": { "post": { "description": "Update Batch", "operationId": "UpdateBatch", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nmutation UpdateBatch($batch_id: ID!, $ship_from: ID, $fba: Boolean, $purchase_order_id: ID, $name: String, $archived: Boolean, $deleted: Boolean, $tags: [TagInput], $prep_type: String, $current_step: Int, $flow: Int) {\n updateBatch(\n batch_id: $batch_id\n ship_from: $ship_from\n fba: $fba\n purchase_order_id: $purchase_order_id\n name: $name\n archived: $archived\n deleted: $deleted\n tags: $tags\n prep_type: $prep_type\n current_step: $current_step\n flow: $flow\n ) {\n _id\n name\n marketplace\n ship_from_id\n ship_from\n fba\n created\n archived\n deleted\n tags {\n _id\n name\n color\n }\n total_quantity\n total_count\n shipments\n total_in_shipments\n misc\n batch_type\n carryover_for\n feed_errors\n prep_type\n dirty\n disabled\n purchase_order_id\n current_step\n flow\n }\n}\n```", "type": "string" }, "variables": { "properties": { "batch_id": { "type": "string" }, "ship_from": { "type": "string" }, "fba": { "type": "boolean" }, "purchase_order_id": { "type": "string" }, "name": { "type": "string" }, "archived": { "type": "boolean" }, "deleted": { "type": "boolean" }, "tags": { "items": { "$ref": "#/components/schemas/tag" }, "type": "array" }, "prep_type": { "enum": [ "AMAZON_LABEL", "SELLER_LABEL" ], "type": "string" }, "current_step": { "type": "integer" }, "flow": { "type": "integer", "enum": [ 0, 1 ] } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "updateBatch": { "$ref": "#/components/schemas/batch" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Update Batch" } }, "/graphql?op=BatchItems": { "post": { "summary": "Get BatchItems", "operationId": "BatchItems", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nquery BatchItems($batchId: ID) {\n batchSummary(batch_id: $batchId) {\n batch_id\n total_cost\n total_payout\n avg_rank\n creating_listings\n }\n batchItems(batch_id: $batchId) {\n _id\n batch_id\n inventory_id\n inventory {\n _id\n active\n msku\n fnsku\n quantity\n fba\n in_stock\n inbound\n transfer\n price\n payout\n misc\n product_id\n marketplace\n product {\n _id\n asin\n parent\n title\n image\n misc\n rank\n upc\n group\n marketplace\n expiration_required\n product_type\n }\n condition_id\n condition\n tax_code_id\n notes\n tags { _id name color url icon }\n prep_instructions {PrepOwner PrepInstruction}\n prep_details { prepCategory prepTypes allOwnersConstraint prepOwnerConstraint labelOwnerConstraint }\n storage_type\n listings_issues { code message severity attributeNames categories }\n listings_issues_updated\n listings_item { fulfillmentAvailability submitted attributes dimensionsSubmitted }\n listings_status\n update_listings_at\n update_listings_issues\n report_id\n }\n quantity\n unshipped\n quantity_in_case\n damaged\n deleted\n tags { _id name color }\n errors\n buylist {\n _id\n purchased\n quantity\n cost\n expires\n source\n created_by_name\n misc\n origin\n }\n misc\n prep_instructions { PrepOwner PrepInstruction }\n prep_owner\n label_owner\n lot_code\n packing_group_id\n updated\n }\n}\n```", "type": "string" }, "variables": { "type": "object", "properties": { "batch_id": { "type": "string" } } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "batchSummary": { "type": "array", "items": { "type": "object", "properties": { "batch_id": { "type": "string" }, "total_cost": { "type": "integer" }, "total_payout": { "type": "integer" }, "avg_rank": { "type": "integer" }, "creating_listings": { "type": "boolean" } } } }, "batchItems": { "type": "array", "items": { "$ref": "#/components/schemas/batch_item" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "FBA Inbound Shipment", "Amazon" ], "security": [ { "bearer_auth": [] } ] } }, "/graphql?op=CreateBatchItems": { "post": { "summary": "CreateBatchItems", "operationId": "CreateBatchItems", "parameters": [ { "description": "GraphQL query", "name": "op", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "CreateBatchItems" ] } }, { "$ref": "#/components/parameters/x-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "type": "string", "description": "```graphql\nmutation CreateBatchItems(\n $batch_id: ID!,\n $items: [BatchItemInput!],\n $marketplace: String!,\n $manuallyCreateFbaListings: Boolean,\n) {\n createBatchItems(\n batch_id: $batch_id,\n items: $items,\n marketplace: $marketplace,\n manuallyCreateFbaListings: $manuallyCreateFbaListings,\n ) {\n items {\n _id\n batch_id\n inventory_id\n inventory {\n _id\n active\n msku\n fnsku\n quantity\n fba\n in_stock\n inbound\n transfer\n price\n payout\n misc\n product_id\n marketplace\n product {\n _id\n asin\n parent\n title\n image\n misc\n rank\n upc\n group\n marketplace\n expiration_required\n product_type\n }\n condition_id\n condition\n tax_code_id\n notes\n tags { _id name color url icon }\n prep_instructions {PrepOwner PrepInstruction}\n prep_details { prepCategory prepTypes allOwnersConstraint prepOwnerConstraint labelOwnerConstraint }\n storage_type\n listings_issues { code message severity attributeNames categories }\n listings_issues_updated\n listings_item { fulfillmentAvailability submitted attributes dimensionsSubmitted }\n listings_status\n update_listings_at\n update_listings_issues\n report_id\n }\n quantity\n unshipped\n quantity_in_case\n damaged\n tags { _id name color }\n errors\n buylist {\n _id\n purchased\n quantity\n cost\n expires\n source\n created_by_name\n misc\n origin\n }\n misc\n prep_instructions { PrepOwner PrepInstruction }\n prep_owner\n label_owner\n lot_code\n packing_group_id\n updated\n }\n invalid\n }\n}\n```" }, "variables": { "type": "object", "properties": { "batch_id": { "type": "string" }, "marketplace": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/batch_item_input" } }, "manuallyCreateFbaListings": { "type": "boolean" } }, "required": [ "batch_id", "marketplace", "items" ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/batch_item" } }, "invalid": { "type": "array", "description": "An array of items or MSKUs that we were not able to create a batch item for", "items": { "type": "object" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "FBA Inbound Shipment", "Amazon" ], "security": [ { "bearer_auth": [] } ] } }, "/graphql?op=UpdateBatchItem": { "post": { "summary": "Update BatchItem", "operationId": "UpdateBatchItemGql", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "type": "string", "description": "```graphql\nmutation UpdateBatchItem(\n $batch_item_id: ID!,\n $add_quantity: Int,\n $set_quantity: Int,\n $quantity_in_case: Int,\n $tags: [TagInput],\n $deleted: Boolean,\n $buylist: [BuylistInput],\n $inventory: InventoryInput,\n $prep_owner: String,\n $label_owner: String,\n $restore_buylist: Boolean,\n $lot_code: String,\n) {\n updateBatchItem(\n batch_item_id: $batch_item_id,\n add_quantity: $add_quantity,\n set_quantity: $set_quantity,\n quantity_in_case: $quantity_in_case,\n deleted: $deleted,\n tags: $tags,\n buylist: $buylist,\n inventory: $inventory,\n prep_owner: $prep_owner,\n label_owner: $label_owner,\n restore_buylist: $restore_buylist,\n lot_code: $lot_code,\n ) {\n _id\n batch_id\n inventory_id\n inventory {\n _id\n active\n msku\n fnsku\n quantity\n fba\n in_stock\n inbound\n transfer\n price\n payout\n misc\n product_id\n marketplace\n product {\n _id\n asin\n parent\n title\n image\n misc\n rank\n upc\n group\n marketplace\n expiration_required\n product_type\n }\n condition_id\n condition\n tax_code_id\n notes\n tags { _id name color url icon }\n prep_instructions {PrepOwner PrepInstruction}\n prep_details { prepCategory prepTypes allOwnersConstraint prepOwnerConstraint labelOwnerConstraint }\n storage_type\n listings_issues { code message severity attributeNames categories }\n listings_issues_updated\n listings_item { fulfillmentAvailability submitted attributes dimensionsSubmitted }\n listings_status\n update_listings_at\n update_listings_issues\n report_id\n }\n quantity\n unshipped\n quantity_in_case\n damaged\n tags { _id name color }\n errors\n buylist {\n _id\n purchased\n quantity\n cost\n expires\n source\n created_by_name\n misc\n origin\n }\n misc\n prep_instructions { PrepOwner PrepInstruction }\n prep_owner\n label_owner\n lot_code\n packing_group_id\n updated\n }\n}\n```" }, "variables": { "type": "object", "properties": { "batch_item_id": { "type": "string" }, "add_quantity": { "type": "integer" }, "set_quantity": { "type": "integer" }, "quantity_in_case": { "type": "integer" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/tag" } }, "deleted": { "type": "boolean" }, "buylist": { "type": "array", "items": { "$ref": "#/components/schemas/buylist_input" } }, "inventory": { "$ref": "#/components/schemas/inventory_input" }, "prep_owner": { "type": "string" }, "label_owner": { "type": "string" }, "restore_buylist": { "type": "boolean" }, "lot_code": { "type": "string" } }, "required": [ "batch_item_id" ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateBatchItem": { "type": "array", "items": { "$ref": "#/components/schemas/batch_item" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "FBA Inbound Shipment", "Amazon" ], "security": [ { "bearer_auth": [] } ] } }, "/graphql?op=ImportPurchaseOrderItems": { "post": { "summary": "Import PurchaseOrderItems", "operationId": "ImportPurchaseOrderItems", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nmutation ImportPurchaseOrderItems(\n $batch_id: ID!,\n $items: [ImportPurchaseOrderItemInput!]!,\n $ShipToCountryCode: String,\n $send_prep_instructions: Boolean,\n $shipment_per_sku: Boolean\n) {\n importPurchaseOrderItems(\n batch_id: $batch_id\n items: $items\n ShipToCountryCode: $ShipToCountryCode\n send_prep_instructions: $send_prep_instructions\n shipment_per_sku: $shipment_per_sku\n ) {\n _id\n batch_id\n inventory_id\n inventory {\n _id\n active\n msku\n fnsku\n quantity\n fba\n in_stock\n inbound\n transfer\n price\n payout\n misc\n product_id\n marketplace\n product {\n _id\n asin\n parent\n title\n image\n misc\n rank\n upc\n group\n marketplace\n expiration_required\n mapping {\n _id\n upc\n name\n products {\n _id\n quantity\n product {\n _id\n asin\n }\n }\n }\n }\n condition_id\n condition\n tax_code_id\n notes\n tags {\n _id\n name\n color\n url\n }\n prep_instructions {\n PrepOwner\n PrepInstruction\n }\n storage_type\n listings_issues {\n message\n }\n listings_issues_updated\n report_id\n must_send_feed\n active\n product_feed_batch_id\n product_feed_updated\n product_feed_status\n product_feed_errors\n inventory_feed_batch_id\n inventory_feed_updated\n inventory_feed_status\n inventory_feed_errors\n dimensions_feed_batch_id\n dimensions_feed_updated\n dimensions_feed_status\n dimensions_feed_errors\n }\n quantity\n quantity_in_case\n damaged\n purchase_order_batch_items {\n _id\n purchase_order_id\n purchase_order_name\n purchase_order_item_id\n quantity\n }\n deleted\n tags {\n _id\n name\n color\n }\n errors\n buylist {\n _id\n purchased\n quantity\n cost\n expires\n source\n created_by_name\n misc\n origin\n }\n shipments {\n id\n fcid\n prep\n quantity\n cp\n }\n misc\n prep_instructions {\n PrepOwner\n PrepInstruction\n }\n plans {\n plans {\n id\n fcid\n prep\n quantity\n requestId\n prep_instructions {\n PrepOwner\n PrepInstruction\n }\n }\n errors\n planning\n }\n plans_updated\n working_shipments {\n id\n fcid\n prep\n quantity\n cp\n }\n can_ship\n product_feed\n inventory_feed\n dimensions_feed\n }\n}\n```", "type": "string" }, "variables": { "type": "object", "properties": { "batch_id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "purchase_order_item_id": { "type": "string" }, "quantity": { "type": "number" } } } }, "ShipToCountryCode": { "type": "string" }, "send_prep_instructions": { "type": "boolean" }, "shipment_per_sku": { "type": "boolean" } } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "importPurchaseOrderItems": { "type": "array", "items": { "$ref": "#/components/schemas/batch_item" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "FBA Inbound Shipment", "Amazon" ], "security": [ { "bearer_auth": [] } ] } }, "/graphql?op=Buylist": { "post": { "description": "Buylist", "operationId": "Buylist", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nquery Buylist(\n $marketplace: String,\n $asins: [String],\n $filters: JSONObject,\n $archived: Boolean,\n $unattached: Boolean,\n $with_cost: Boolean,\n $with_msku: Boolean,\n $limit: Int,\n $offset: Int)\n{\n buylist(\n marketplace: $marketplace,\n asins: $asins,\n filters: $filters,\n archived: $archived,\n unattached: $unattached,\n with_cost: $with_cost,\n with_msku: $with_msku,\n limit: $limit,\n offset: $offset)\n {\n _id,\n purchased,\n price,\n cost,\n condition,\n source_id,\n source,\n expires,\n quantity,\n misc,\n created_by,\n created_by_name,\n created_by_abbr,\n msku,\n condition_notes,\n product {\n _id,\n asin,\n parent,\n title,\n image,\n misc,\n rank,\n marketplace,\n group,\n upc,\n }\n }\n}\n```", "type": "string" }, "variables": { "properties": { "marketplace": { "type": "string" }, "asins": { "type": "array", "items": { "type": "string" } }, "filters": { "type": "object", "properties": { "purchasedStart": { "description": "Restrict buylist items to those purchased after this date", "type": "string" }, "purchasedEnd": { "description": "Restrict buylist items to those purchased before this date", "type": "string" }, "q": { "type": "string", "description": "Search query. Matches UPC, title, ASIN, or MSKU" }, "groups": { "type": "array", "description": "Filter results by these Group IDs (`group_id`)", "items": { "type": "string" } }, "created_bys": { "type": "array", "description": "Filter results by these Shopper IDs (`created_by`)", "items": { "type": "string" } }, "sources": { "type": "array", "description": "Filter results by these Source/Supplier IDs (`source_id`)", "items": { "type": "string" } }, "size_tiers": { "type": "array", "description": "Filter results by these Size Tiers (`product.misc.size`)", "items": { "type": "string" } } } }, "unattached": { "description": "Only get items that aren't attached to batches or orders", "type": "boolean" }, "with_cost": { "description": "Only get items that have non-zero cost", "type": "boolean" }, "with_msku": { "description": "Only get items that have an MSKU", "type": "boolean" }, "archived": { "description": "False = only non-archived items, True = only archived items, omit to include all", "type": "boolean" }, "limit": { "description": "Select at most this number of items", "type": "integer" }, "offset": { "description": "Use with `limit` to page through > `limit` items", "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "Buylist": { "type": "array", "items": { "$ref": "#/components/schemas/buylist" } } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Mobile", "Amazon" ], "summary": "Get Buylist items" } }, "/graphql?op=Inventory": { "post": { "description": "Inventory", "operationId": "Inventory", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nquery Inventory(\n $asins: [String!],\n $active: Boolean,\n $unlisted: Boolean,\n $limit: Int,\n $offset: Int,\n $marketplace: String,\n $filters: JSONObject,\n $ship_from: [ID],\n $sort_by: String\n) {\n inventory(\n asins: $asins\n active: $active\n unlisted: $unlisted\n limit: $limit\n offset: $offset\n marketplace: $marketplace\n filters: $filters\n ship_from: $ship_from\n sort_by: $sort_by\n ) {\n _id\n active\n msku\n fnsku\n quantity\n fba\n in_stock\n inbound\n transfer\n price\n ceiling\n floor\n payout\n misc\n product_id\n marketplace\n product {\n _id\n asin\n parent\n title\n image\n misc\n rank\n upc\n group\n }\n condition_id\n condition\n tax_code_id\n notes\n ordered\n received\n damaged\n missing\n ship_from {\n ship_from_id\n ship_from_name\n ordered\n received\n damaged\n missing\n }\n tags {\n _id\n name\n color\n url\n }\n prep_instructions {\n PrepOwner\n PrepInstruction\n }\n storage_type\n listings_issues {\n message\n }\n listings_issues_updated\n report_id\n }\n}\n```", "type": "string" }, "variables": { "properties": { "asins": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "unlisted": { "type": "boolean" }, "limit": { "description": "Select at most this number of items", "type": "integer" }, "offset": { "description": "Use with `limit` to page through > `limit` items", "type": "integer" }, "marketplace": { "type": "string" }, "filters": { "type": "object", "properties": { "q": { "type": "string", "description": "Search query. Matches UPC, title, ASIN, or MSKU" }, "fulfillable": { "type": "string", "description": "`\"in-stock\"` or `\"out-of-stock\"`" } } }, "ship_from": { "type": "array", "items": { "type": "integer" } }, "sort_by": { "description": "`\"open_date\"` or `\"listed\"`", "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "Inventory": { "type": "array", "items": { "$ref": "#/components/schemas/inventory" } } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "Inventory" ], "summary": "Get Inventory" } }, "/graphql?op=UpdateInventoryItems": { "post": { "description": "Update InventoryItems", "operationId": "UpdateInventoryItems", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "query": { "description": "```graphql\nmutation UpdateInventoryItems(\n $marketplace: String,\n $items: [InventoryInput!]!\n) {\n updateInventoryItems(\n marketplace: $marketplace,\n items: $items\n ) {\n _id\n msku\n product_id\n marketplace\n product { _id asin }\n condition_id\n condition\n tax_code_id\n notes\n tags { _id name color url }\n }\n}\n```", "type": "string" }, "variables": { "properties": { "marketplace": { "description": "Can be omitted if every item has a marketplace", "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "msku": { "description": "The MSKU of the item to update", "type": "string" }, "marketplace": { "description": "Can be omitted if the top-level marketplace is set", "type": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "integer", "description": "The decimal representation of a hex color. Eg. #ff0000 = 16711680, #0000ff = 255" }, "url": { "type": "string" } } } } } } } }, "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "UpdateInventoryItems": { "type": "array", "items": { "$ref": "#/components/schemas/inventory" } } }, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "Inventory" ], "summary": "Update InventoryItems" } }, "/scout/buylist": { "post": { "description": "Create buylist items", "operationId": "createBuylist", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "properties": { "items": { "description": "```json\n[\n {\n \"asin\": \"the asin, required\",\n \"msku\": \"the msku, will save as inventory._id, if the record already exists in inventory\",\n \"import-msku\": \"save the msku in the misc column, will be used when the item is listed\",\n \"purchased\": \"the date you purchased this item\",\n \"condition\": \"the item condition, eg. 'NewItem', 'UsedAcceptable', etc\",\n \"cost\": cost in cents (eg 599 = $5.99),\n \"source\": \"the source\",\n \"expires\": \"date item expires\",\n \"notifyme\": number of days before expiration to notify me,\n \"quantity\": number of items purchased,\n // the following fields will be stored in misc\n \"stocked-variations\",\n \"variations\",\n \"tax-code._id\",\n \"tax-percentage\",\n \"notes\",\n \"discount\",\n \"originalCost\",\n \"labor-cost\",\n \"inbound-shipping-cost\"\n }\n]\n```", "format": "json", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Amazon", "Mobile", "Walmart" ], "summary": "Create Buylist items" } }, "/list/pack-history": { "get": { "description": "Get PackHistory", "operationId": "getPackHistory", "parameters": [ { "description": "Get items packed after this timestamp", "in": "query", "name": "start", "schema": { "type": "string", "example": "2025-01-01" } }, { "description": "Get items packed before this timestamp", "in": "query", "name": "end", "schema": { "type": "string", "example": "2025-02-01" } }, { "description": "Optional comma-separated list of user ids to restrict to", "in": "query", "name": "created-by", "schema": { "type": "string", "example": "2f16c5b2-97d3-4238-8b89-22851363bf27" } }, { "description": "Optional comma-separated list of shipment ids to restrict to", "in": "query", "name": "shipment", "schema": { "type": "string", "example": "FBA18V17NFFD" } }, { "description": "Must be `XMLHttpRequest`", "in": "header", "name": "X-Requested-With", "required": true, "schema": { "type": "string", "example": "XMLHttpRequest" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "properties": { "username": { "description": "The name of the user who packed the item(s).", "type": "string" }, "userid": { "description": "The internal id of the user who packed the item(s).", "type": "string" }, "at": { "description": "When the item was packed.", "type": "string" }, "quantity": { "description": "How much of the item was packed.", "type": "integer" }, "expires": { "description": "The expiration date of the item.", "type": "string" }, "deleted": { "description": "Whether or not the item was deleted.", "type": "boolean" }, "msku": { "description": "The MSKU of the item that was packed.", "type": "string" }, "fnsku": { "description": "The FNSKU of the item that was packed.", "type": "string" }, "asin": { "description": "The ASIN of the item that was packed.", "type": "string" }, "fcid": { "description": "The destination fulfillment center, if any.", "type": "string" }, "shipmentname": { "description": "The name of the shipment, if any.", "type": "string" }, "shipped": { "description": "When the shipment was shipped, or null if not yet shipped.", "type": "string" }, "total-weight": { "description": "The total weight of the shipment. Eg. 3025 = 30.25lbs", "type": "integer" }, "metric": { "description": "True if the boxes were created with metric units, false if imperial", "type": "boolean" }, "pallet-count": { "description": "The number of pallets in the shipment.", "type": "integer" }, "content-status": { "description": "The status of the shipment", "type": "string" }, "carrier": { "description": "Who will be shipping the shipment", "type": "string" }, "reference-id": { "description": "The reference ID", "type": "string" }, "estimate": { "description": "Estimated transportation cost", "type": "string" }, "shipping_mode": { "description": "SPD, LTL, etc.", "type": "string" }, "partnered": { "description": "True if Amazon Partnered Carrier, false otherwise", "type": "boolean" }, "shipment": { "description": "The id of the shipment. Eg. FBA18V17NFFD", "type": "boolean" }, "box": { "description": "The index of the box the item was packed into", "type": "integer" }, "tracking_id": { "description": "The tracking ID", "type": "string" }, "ship-from-name": { "description": "The name on the ship-from address", "type": "string" }, "ship-from": { "description": "A JSON encoded string representing the ship-from address", "type": "string" }, "batches": { "description": "A JSON encoded string representing an array of batches that were the source of this item.", "type": "string" }, "shipment-value": { "description": "The sum of the price × quantity of all items in the shipment.", "type": "integer" } }, "type": "object" }, "type": "array" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "basic_auth": [] } ], "tags": [ "Report", "FBA Inbound Shipment" ], "summary": "Get PackHistory" } }, "/api/wm/v3/token": { "post": { "summary": "Get Walmart AccessToken", "description": "Wrapper around Walmart's [token API](https://developer.walmart.com/global-marketplace/reference/tokenapi) except we'll use your refresh token (or client id and client secret) automatically and provide the correct parameters for you", "operationId": "getWmAccessToken", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "number" }, "refresh_token": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Auth", "Walmart" ] } }, "/api/wm/v3/items/catalog/search": { "post": { "summary": "Catalog Search", "description": "Wrapper around Walmart's [getCatalogSearch API](https://developer.walmart.com/global-marketplace/reference/getcatalogsearch)", "operationId": "catalogSearch", "parameters": [ { "name": "query", "in": "query", "description": "Search query string. Supports wildcard queries using * and ?", "required": false, "schema": { "type": "string", "example": "smartphone" } }, { "name": "sku", "in": "query", "description": "Filter by SKU", "required": false, "schema": { "type": "string", "example": "SKU123456" } }, { "name": "gtin", "in": "query", "description": "Filter by GTIN (Global Trade Item Number)", "required": false, "schema": { "type": "string", "example": "1234567890123" } }, { "name": "upc", "in": "query", "description": "Filter by UPC", "required": false, "schema": { "type": "string", "example": "123456789012" } }, { "name": "wpid", "in": "query", "description": "Filter by Walmart Product ID", "required": false, "schema": { "type": "string", "example": "55391906" } }, { "name": "category", "in": "query", "description": "Filter by category name or ID", "required": false, "schema": { "type": "string", "example": "Electronics" } }, { "name": "publishStatus", "in": "query", "description": "Filter by publish status", "required": false, "schema": { "type": "string", "enum": [ "PUBLISHED", "UNPUBLISHED", "STAGE", "IN_PROGRESS", "READY_TO_PUBLISH", "SYSTEM_PROBLEM", "CONTENT_UNDER_REVIEW" ] } }, { "name": "lifecycleStatus", "in": "query", "description": "Filter by lifecycle status", "required": false, "schema": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ] } }, { "name": "hasInventory", "in": "query", "description": "Filter items that have inventory available", "required": false, "schema": { "type": "boolean", "example": true } }, { "name": "price.min", "in": "query", "description": "Minimum price filter", "required": false, "schema": { "type": "number", "format": "double", "minimum": 0, "example": 10 } }, { "name": "price.max", "in": "query", "description": "Maximum price filter", "required": false, "schema": { "type": "number", "format": "double", "minimum": 0, "example": 100 } }, { "name": "fromDate", "in": "query", "description": "Filter items modified from this date (ISO 8601 format)", "required": false, "schema": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00Z" } }, { "name": "toDate", "in": "query", "description": "Filter items modified to this date (ISO 8601 format)", "required": false, "schema": { "type": "string", "format": "date-time", "example": "2024-12-31T23:59:59Z" } }, { "name": "sortBy", "in": "query", "description": "Sort results by specified field", "required": false, "schema": { "type": "string", "enum": [ "sku", "itemName", "price", "publishStatus", "lifecycleStatus", "lastUpdated", "createdDate" ], "default": "lastUpdated" } }, { "name": "sortOrder", "in": "query", "description": "Sort order for results", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ], "default": "DESC" } }, { "name": "page", "in": "query", "description": "Indicates which page of results to retrieve for paginated data.", "schema": { "type": "number", "default": 0 } }, { "name": "limit", "in": "query", "description": "Maximum number of results to return per page", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 100, "example": 50 } }, { "$ref": "#/components/parameters/x-wm-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "description": "Response Status" }, "payload": { "type": "object", "properties": { "mart": { "type": "string", "description": "The marketplace name.", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ] }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "condition": { "type": "string", "description": "The condition of the item." }, "wpid": { "type": "string", "description": "The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com." }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "isbn": { "type": "string", "description": "International Standard Book Number" }, "ean": { "type": "string", "description": "Product ID, EANs must be 13 digits in length." }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "itemId": { "type": "string", "description": "A unique Id which identifies the item." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name." }, "shelf": { "type": "string", "description": "Walmart assigned an item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type." }, "price": { "type": "object", "description": "Specifies item purchase price information, including currency and amount.", "properties": { "unit": { "type": "string", "description": "The currency type.", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ] }, "amount": { "type": "number", "description": "The numerical amount of the price." } } }, "brand": { "type": "string", "description": "Brand of Item." }, "num_reviews": { "type": "string", "description": "The reviewed times for Items." }, "customerRating": { "type": "string", "description": "Customer rating." }, "manufacturer": { "type": "string", "description": "manufacturer of Item." }, "fulfillmentType": { "type": "string", "description": "Fulfillment information." }, "publishedStatus": { "type": "object", "description": "The status of an item when the item is in the submission process.", "properties": { "status": { "type": "string", "description": "The published status of an item describes where the item is in the submission process.", "enum": [ "PUBLISHED", "READY_TO_PUBLISH", "IN_PROGRESS", "UNPUBLISHED", "STAGE", "SYSTEM_PROBLEM" ] }, "reasons": { "type": "array", "description": "Explains the reason why an item is unpublished.", "items": { "type": "string" } } } }, "inventoryStatus": { "type": "string", "description": "It indicates whether the product is in stock or not." }, "lifecycleStatus": { "type": "string", "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle.", "enum": [ "ACTIVE", "ARCHIVED", "RETIRED" ] }, "shop_ref": { "type": "string" }, "shop_product_id": { "type": "string" }, "shop_variant_id": { "type": "string" }, "variantGroupId": { "type": "string", "description": "Variant Id if the item is of type Variant" }, "variantGroupInfo": { "type": "object", "description": "Additional variant group information if the item is of type Variant", "properties": { "isPrimary": { "type": "boolean", "description": "Returns true if the item is a primary variant" }, "groupingAttributes": { "type": "object", "description": "The list of variant attributes used to create the variant item", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "primary": { "type": "boolean" } } } } }, "totalItems": { "type": "number", "description": "Total items for the query" }, "limit": { "type": "number", "description": "Number of items shown in this page" }, "nextCursor": { "type": "number", "description": "Used for pagination to fetch the next set of items" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Walmart Catalog", "Walmart" ] } }, "/api/wm/v3/feeds?feedType=MP_ITEM_MATCH": { "post": { "description": "Get ItemSetup by Match", "operationId": "itemSetupByMatch", "parameters": [ { "$ref": "#/components/parameters/x-wm-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "MPItemFeedHeader": { "properties": { "sellingChannel": { "type": "string", "enum": [ "mpsetupbymatch" ] }, "locale": { "type": "string", "enum": [ "en" ] }, "version": { "type": "string", "enum": [ "4.2" ] } }, "type": "object" }, "MPItem": { "type": "array", "items": { "type": "object", "properties": { "Item": { "type": "object", "properties": { "sku": { "type": "string" }, "condition": { "type": "string" }, "productIdentifiers": { "type": "object", "properties": { "productIdType": { "type": "string", "enum": [ "GTIN" ] }, "productId": { "type": "string" } } }, "price": { "type": "number" }, "ShippingWeight": { "type": "number" } } } } } } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "feedId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Inventory", "Walmart" ], "summary": "Get ItemSetup by Match" } }, "/api/wm/v3/feeds?feedType=inventory": { "post": { "description": "Bulk Inventory Update", "operationId": "bulkInventoryUpdate", "parameters": [ { "$ref": "#/components/parameters/x-wm-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "InventoryHeader": { "properties": { "version": { "type": "string", "enum": [ "1.4" ] } }, "type": "object" }, "Inventory": { "type": "array", "items": { "type": "object", "properties": { "sku": { "type": "string" }, "quantity": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "EACH" ] }, "amount": { "type": "number" } } } } } } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "feedId": { "type": "string" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Inventory", "Walmart" ], "summary": "Bulk Inventory Update" } }, "/api/wm/v3/feeds": { "get": { "summary": "Get All FeedStatuses", "description": "Wrapper around Walmart's [allFeedStatuses API](https://developer.walmart.com/global-marketplace/reference/getallfeedstatuses)", "operationId": "allFeedStatuses", "parameters": [ { "name": "feedId", "in": "query", "description": "A unique ID returned from the Bulk Upload API, used for tracking the Feed File.", "schema": { "type": "string" } }, { "name": "feedType", "in": "query", "description": "The feed type.", "schema": { "type": "string" } }, { "name": "feedStatus", "in": "query", "description": "Status of the feed.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "The object response to start with, where 0 is the first entity that can be requested.", "schema": { "type": "string", "default": "0" } }, { "name": "limit", "in": "query", "description": "The number of entities to be returned. It cannot be more than 50 entities.", "schema": { "type": "string", "default": "50" } }, { "$ref": "#/components/parameters/x-wm-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "description": { "type": "string" }, "info": { "type": "string" }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ] }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ] }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" } } } }, "errorIdentifiers": { "type": "object" }, "component": { "type": "string" }, "type": { "type": "string" }, "serviceName": { "type": "string" }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ] } } } }, "totalResults": { "type": "number" }, "offset": { "type": "number" }, "limit": { "type": "number" }, "results": { "type": "object", "properties": { "feed": { "type": "array", "items": { "type": "object", "properties": { "feedId": { "type": "string", "description": "A unique ID used for tracking the Feed File." }, "feedSource": { "type": "string", "description": "The source of the feed." }, "feedType": { "type": "string", "description": "Indicates the feed type." }, "partnerId": { "type": "string", "description": "Indicates the seller ID." }, "itemsReceived": { "type": "number", "description": "The number of items received." }, "itemsSucceeded": { "type": "number", "description": "The number of items succeeded." }, "itemsFailed": { "type": "number", "description": "The number of items in the feed that failed due to a data or system error." }, "itemsProcessing": { "type": "number", "description": "The number of items in the feed that are still in progress." }, "feedStatus": { "type": "string", "enum": [ "RECEIVED", "INPROGRESS", "PROCESSED", "ERROR" ] }, "feedDate": { "type": "number", "description": "The date and time the feed was submitted." }, "batchId": { "type": "string", "description": "The batch ID for the feed, if provided." }, "modifiedDtm": { "type": "number", "description": "The most recent time the feed was modified." } } } } } } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Inventory", "Walmart" ] } }, "/api/wm/v3/items/{sku}": { "delete": { "summary": "Retire an Inventory Item", "description": "Wrapper around Walmart's [retireAnItem API](https://developer.walmart.com/global-marketplace/reference/retireanitem)", "operationId": "retireAnItem", "parameters": [ { "name": "sku", "in": "path", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-wm-access-token" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item." }, "message": { "type": "string", "description": "Message confirming the deletion or retirement of an item from the Walmart Catalog" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Inventory", "Walmart" ] } }, "/api/v2/item-label": { "post": { "summary": "Generate item labels", "operationId": "itemLabel", "parameters": [ { "in": "header", "name": "Accept", "description": "Specify `application/pdf` and the response body will be raw PDF data", "schema": { "type": "string", "enum": [ "application/pdf" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Label Dimensions", "type": "object", "required": [ "label_width", "label_height", "items" ], "properties": { "label_width": { "type": "number", "description": "The width of the label in inches" }, "label_height": { "type": "number", "description": "The height of the label in inches" }, "items": { "description": "A list of items to generate labels for", "type": "array", "items": { "type": "object", "required": [ "barcode_value" ], "properties": { "title": { "type": "string" }, "barcode_value": { "type": "string" }, "condition": { "type": "string" }, "expires": { "type": "string" }, "copies": { "type": "number" }, "marketplace": { "type": "string" }, "fc_id": { "type": "string" }, "shipment_id": { "type": "string" }, "lot_code": { "type": "string", "description": "Manufacturing lot code" } } } }, "opts": { "type": "object", "properties": { "font_size": { "type": "number" }, "title_wrap": { "type": "boolean" }, "abbr_business": { "type": "string" } } } } } } } }, "responses": { "200": { "content": { "text/plain": { "schema": { "description": "Data to render the label with", "type": "string" } }, "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "description": "Success" }, "202": { "$ref": "#/components/responses/202" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "Printing", "Walmart" ] } }, "/api/wm/v3/fulfillment/inbound-shipments": { "get": { "summary": "Get InboundShipments", "operationId": "getInboundShipments", "description": "Wrapper around Walmart's [Get Shipments](https://developer.walmart.com/us-marketplace/reference/getinboundshipments) API\n", "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "string", "default": "0" } }, { "name": "limit", "in": "query", "schema": { "type": "string", "default": "10" } }, { "name": "inboundOrderId", "in": "query", "schema": { "type": "string" } }, { "name": "shipmentId", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "fromCreateDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "toCreateDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "$ref": "#/components/parameters/x-wm-access-token" } ], "responses": { "200": { "description": "Get Inbound Shipments response", "content": { "application/json": { "schema": { "type": "object", "properties": { "headers": { "type": "object", "properties": { "totalCount": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } }, "payload": { "type": "array", "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "shipToAddress": { "$ref": "#/components/schemas/wm.Address" }, "returnAddress": { "$ref": "#/components/schemas/wm.Address" }, "status": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "shipmentUnits": { "type": "integer" }, "receivedUnits": { "type": "integer" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "actualDeliveryDate": { "type": "string", "format": "date-time" }, "trackingNo": { "type": "array", "items": { "type": "string" } }, "carrierName": { "type": "string" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "WFS Shipment", "Walmart" ], "security": [ { "bearer_auth": [] } ] }, "post": { "summary": "Create InboundShipment", "operationId": "createInboundShipment", "description": "Wrapper around Walmart's [Create Inbound Shipment](https://developer.walmart.com/us-marketplace/reference/createshipment) API\n", "parameters": [ { "$ref": "#/components/parameters/x-wm-access-token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "inboundOrderId", "returnAddress", "orderItems" ], "properties": { "inboundOrderId": { "type": "string" }, "inboundServices": { "type": "object", "properties": { "inventoryTransferService": { "type": "string", "enum": [ "Y", "N" ] } } }, "returnAddress": { "type": "object", "required": [ "addressLine1", "city", "stateCode", "countryCode", "postalCode" ], "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "countryCode": { "type": "string" }, "postalCode": { "type": "string" } } }, "orderItems": { "type": "array", "description": "length between 1 and 5000", "items": { "$ref": "#/components/schemas/wm.OrderItem" } } } } } } }, "responses": { "200": { "description": "Shipment created", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object", "properties": { "shipmentId": { "type": "string" }, "shipToAddress": { "type": "object", "properties": { "fcName": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "countryCode": { "type": "string" }, "postalCode": { "type": "string" } } }, "shipmentItems": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "itemQty": { "type": "integer" } } } }, "expectedDeliveryDate": { "type": "string" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "WFS Shipment", "Walmart" ], "security": [ { "bearer_auth": [] } ] } }, "/api/wm/v3/fulfillment/inbound-preview": { "post": { "summary": "Fetch InboundPreview", "operationId": "fetchInboundPreview", "description": "Wrapper around Walmart's [Fetch Inbound Preview](https://developer.walmart.com/us-marketplace/reference/inboundpreview) API\n", "parameters": [ { "$ref": "#/components/parameters/x-wm-access-token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "header": { "type": "object", "properties": { "headerAttributes": { "type": "object", "required": [ "buId", "martId" ], "properties": { "buId": { "type": "string" }, "martId": { "type": "string" } } } } }, "payload": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "returnAddress": { "type": "object", "required": [ "addressLine1", "city", "stateCode", "countryCode", "postalCode" ], "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "countryCode": { "type": "string" }, "postalCode": { "type": "string" } } }, "orderItems": { "type": "array", "items": { "$ref": "#/components/schemas/wm.OrderItem" } } } } } } } } }, "responses": { "200": { "description": "Inbound preview result", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "payload": { "type": "array", "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "previews": { "type": "array", "items": { "type": "object", "properties": { "shipNode": { "type": "string" }, "isSortable": { "type": "boolean" }, "isNonSortable": { "type": "boolean" }, "nodeType": { "type": "string", "enum": [ "FC", "ICC" ] }, "shipToAddress": { "type": "object", "properties": { "fcName": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "countryCode": { "type": "string" }, "postalCode": { "type": "string" } } }, "shipmentItems": { "type": "array", "items": { "type": "object", "properties": { "vendorSku": { "type": "string" }, "productType": { "type": "string" }, "productId": { "type": "string" }, "itemQty": { "type": "integer" } } } }, "totalNetTransferCharge": { "type": "number" }, "currencyUnit": { "type": "string" } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "WFS Shipment", "Walmart" ], "security": [ { "bearer_auth": [] } ] } }, "/api/wm/v3/fulfillment/shipment-quantities/{shipmentId}": { "put": { "summary": "Update Shipment Quantities", "operationId": "updateShipmentQuantities", "description": "Wrapper around Walmart's [Update Shipment Quantities](https://developer.walmart.com/us-marketplace/reference/updateshipmentquantity) API\n", "parameters": [ { "name": "shipmentId", "in": "path", "required": true, "description": "ID of the shipment to update", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-wm-access-token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "orderItems": { "type": "array", "items": { "type": "object", "required": [ "sku", "updatedShipmentQty" ], "properties": { "sku": { "type": "string" }, "updatedShipmentQty": { "type": "integer" } } } } } } } } }, "responses": { "200": { "description": "Update shipment quantities result", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "payload": { "type": "object" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/wm.Error" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "WFS Shipment", "Walmart" ], "security": [ { "bearer_auth": [] } ] } }, "/api/wm/v3/fulfillment/shipment-tracking/{shipmentId}": { "post": { "summary": "Update Walmart Shipment Tracking Details", "operationId": "updateWmShipmentTrackingDetails", "description": "Wrapper around Walmart's [Update Shipment Tracking](https://developer.walmart.com/us-marketplace/reference/updateshipmenttrackingdetails) API\n", "parameters": [ { "name": "shipmentId", "in": "path", "required": true, "description": "ID of the shipment to update", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-wm-access-token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "carrierName": { "type": "string" }, "trackingInfo": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Update shipment quantities result", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "payload": { "type": "object" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/wm.Error" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "WFS Shipment", "Walmart" ], "security": [ { "bearer_auth": [] } ] } }, "/api/wm/v3/fulfillment/inbound-shipments-quote": { "post": { "summary": "Create Carrier Rate Quote", "operationId": "createCarrierRateQuote", "description": "Wrapper around Walmart's [Create Carrier Rate Quote](https://developer.walmart.com/us-marketplace/reference/createcarrierratequote) API\n", "parameters": [ { "$ref": "#/components/parameters/x-wm-access-token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "title": "Parcel Quote", "required": [ "payload" ], "properties": { "payload": { "type": "object", "required": [ "shipmentId", "quoteType", "units" ], "properties": { "shipmentId": { "type": "string" }, "quoteType": { "type": "string" }, "units": { "type": "array", "items": { "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/wm.Address2" }, "origin": { "allOf": [ { "$ref": "#/components/schemas/wm.Address2" }, { "type": "object", "properties": { "locationName": { "type": "string" } } } ] }, "unitDetails": { "type": "object", "properties": { "shipmentPackages": { "type": "array", "items": { "$ref": "#/components/schemas/wm.ParcelShipmentPackage" } } } } } } } } } } }, { "type": "object", "title": "LTL Quote", "required": [ "payload" ], "properties": { "payload": { "type": "object", "required": [ "shipmentId", "quoteType", "units" ], "properties": { "shipmentId": { "type": "string" }, "quoteType": { "type": "string" }, "pickUpFromDate": { "type": "string", "format": "date-time" }, "pickUpToDate": { "type": "string", "format": "date-time" }, "units": { "type": "array", "items": { "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/wm.Address2" }, "origin": { "$ref": "#/components/schemas/wm.Address2" }, "unitDetails": { "type": "object", "properties": { "freightClass": { "type": "number" }, "declaredValue": { "type": "number" }, "totalPalletCount": { "type": "number" }, "shipmentPackages": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/wm.LtlShipmentPackage" }, { "type": "object", "properties": { "isStackable": { "type": "boolean" } } } ] } } } } } } } } } } } ] } } } }, "responses": { "200": { "description": "Create carrier rate quote result", "content": { "application/json": { "schema": { "type": "object", "properties": { "shipmentId": { "type": "string" }, "shipmentNumber": { "type": "string" }, "rateQuotes": { "type": "array", "items": { "type": "object", "properties": { "quoteId": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string", "format": "date-time" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "currency": { "type": "string" }, "discountCharge": { "type": "number" }, "netCharge": { "type": "number" }, "surchargeType": { "type": "string" }, "surchargeValue": { "type": "string" }, "totalBillingWeight": { "type": "number" }, "status": { "type": "string" }, "transitDays": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "expiryDate": { "type": "string", "format": "date-time" }, "mode": { "$ref": "#/components/schemas/wm.Mode" }, "sellerFreightClassCode": { "type": "string" }, "freightCharge": { "type": "number" }, "fuelCharge": { "type": "number" }, "totalWeight": { "type": "number" }, "totalVolume": { "type": "number" }, "equipmentTypeCode": { "type": "string" }, "serviceCode": { "type": "string" }, "numberOfPallets": { "type": "integer" }, "nominalCharge": { "type": "number" }, "assessorialCharge": { "type": "number" }, "serviceCharge": { "type": "number" }, "minimumCharge": { "type": "number" }, "declaredValue": { "type": "string" }, "mixedSKUs": { "type": "integer" }, "singleSKUs": { "type": "integer" }, "freightReadyDate": { "type": "string", "format": "date-time" } } } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/wm.Error" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "WFS Shipment", "Walmart" ], "security": [ { "bearer_auth": [] } ] } }, "/api/v2/webhook": { "get": { "summary": "List WebHooks", "operationId": "selectWebHooks", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "hooks": { "type": "array", "items": { "$ref": "#/components/schemas/webhook" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "Webhooks", "Amazon" ], "security": [ { "bearer_auth": [] } ] } }, "/api/v2/webhook/{web_hook_id}/secret_key": { "patch": { "summary": "Generate WebHook SecretKey", "operationId": "generateWebHookSecretKey", "parameters": [ { "name": "web_hook_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "secret_key": { "type": "string" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "Webhooks", "Amazon" ], "security": [ { "bearer_auth": [] } ] } }, "/api/v2/webhook/{name}/test": { "put": { "summary": "Test WebHook", "operationId": "testWebHook", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "type": "object" }, "response": { "type": "object" }, "error": { "type": "object" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "Webhooks", "Amazon" ], "security": [ { "bearer_auth": [] } ] } }, "/api/v2/webhook/{web_hook_id}": { "put": { "summary": "Update WebHook", "operationId": "updateWebHook", "parameters": [ { "name": "web_hook_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "endpoint": { "type": "string" }, "options": { "type": "object", "additionalProperties": { "type": "string" } }, "enabled": { "type": "boolean" } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "hook": { "$ref": "#/components/schemas/webhook" }, "error": { "type": "object" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "Webhooks", "Amazon" ], "security": [ { "bearer_auth": [] } ] }, "delete": { "summary": "Delete WebHook", "operationId": "deleteWebHook", "parameters": [ { "name": "web_hook_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "web_hook_id": { "format": "int64", "type": "integer" }, "error": { "type": "object" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "Webhooks", "Amazon" ], "security": [ { "bearer_auth": [] } ] } }, "/api/wm/v3/fulfillment/carrier-rate-quotes/{shipmentId}/{mode}": { "get": { "summary": "Get Carrier RateQuote", "operationId": "getCarrierRateQuote", "description": "Wrapper around Walmart's [Get Carrier Rate Quote](https://developer.walmart.com/us-marketplace/reference/getcarrierratequote) API\n", "parameters": [ { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mode", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/wm.Mode" } }, { "$ref": "#/components/parameters/x-wm-access-token" } ], "responses": { "200": { "description": "Get carrier rate quote result", "content": { "application/json": { "schema": { "type": "object", "properties": { "shipmentId": { "type": "string" }, "quoteId": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string", "format": "date-time" }, "quoteCreationDate": { "type": "string", "format": "date-time" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "rateQuote": { "type": "object", "properties": { "quoteId": { "type": "string" }, "estimatedDeliveryDateTime": { "type": "string", "format": "date-time" }, "carrier": { "type": "object", "properties": { "carrierId": { "type": "string" }, "carrierName": { "type": "string" } } }, "currency": { "type": "string" }, "discountCharge": { "type": "number" }, "netCharge": { "type": "number" }, "surchargeType": { "type": "string" }, "surchargeValue": { "type": "string" }, "totalBillingWeight": { "type": "number" }, "status": { "type": "string" } } }, "shipmentPackages": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/wm.ParcelShipmentPackage" }, { "$ref": "#/components/schemas/wm.LtlShipmentPackage" } ] } }, "originLocation": { "type": "object", "properties": { "locationName": { "type": "string" }, "address": { "$ref": "#/components/schemas/wm.Address" }, "locationId": { "type": "string" } } }, "destinationLocation": { "type": "object", "properties": { "locationName": { "type": "string" }, "address": { "$ref": "#/components/schemas/wm.Address" }, "locationId": { "type": "string" } } }, "returnLocation": { "type": "object", "properties": { "locationName": { "type": "string" }, "address": { "$ref": "#/components/schemas/wm.Address" } } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/wm.Error" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "Walmart", "WFS Shipment" ], "security": [ { "bearer_auth": [] } ] } }, "/api/wm/v3/fulfillment/inbound-shipments-booking": { "post": { "summary": "Create Booking", "operationId": "createBooking", "description": "Wrapper around Walmart's [Create Booking](https://developer.walmart.com/us-marketplace/reference/submitbookingquotes) API\n", "parameters": [ { "$ref": "#/components/parameters/x-wm-access-token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "title": "Parcel Quote", "required": [ "payload" ], "properties": { "payload": { "type": "object", "required": [ "shipmentId", "bookingDetails" ], "properties": { "shipmentId": { "type": "string" }, "bookingDetails": { "type": "object", "required": [ "quoteType", "quoteId", "unitDetails" ], "properties": { "quoteType": { "type": "string", "enum": [ "PARCEL" ] }, "quoteId": { "type": "string" }, "unitDetails": { "type": "array", "items": { "type": "object", "required": [ "noOfSingleSkuBoxes", "noOfMixedSkuBoxes" ], "properties": { "noOfSingleSkuBoxes": { "type": "number" }, "noOfMixedSkuBoxes": { "type": "number" } } } } } } } } } }, { "type": "object", "title": "LTL Quote", "required": [ "payload" ], "properties": { "payload": { "type": "object", "required": [ "shipmentId", "bookingDetails" ], "properties": { "shipmentId": { "type": "string" }, "bookingDetails": { "type": "object", "required": [ "termsAcceptedTime", "quoteType", "quoteId", "pickupDetails", "shipperInfo", "locations", "unitDetails" ], "properties": { "termsAcceptedTime": { "type": "string", "format": "date-time" }, "quoteType": { "type": "string", "enum": [ "PARCEL" ] }, "quoteId": { "type": "string" }, "pickupDetails": { "type": "object", "required": [ "businessLocationName", "freightPickUpDate" ], "properties": { "businessLocationName": { "type": "string" }, "pickupInstruction": { "type": "string" }, "freightPickUpDate": { "type": "string", "format": "date-time" } } }, "shipperInfo": { "type": "object", "required": [ "contactInfo", "firstName", "requesterType" ], "properties": { "contactInfo": { "type": "object", "required": [ "primaryContactPhoneNumber", "primaryContactEmailAddress" ], "properties": { "primaryContactPhoneNumber": { "type": "string" }, "primaryContactEmailAddress": { "type": "string" } } }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "name": { "type": "string" }, "requesterType": { "type": "string" } } }, "locations": { "type": "object", "required": [ "origin", "destination" ], "properties": { "origin": { "required": [ "addressLine1", "city", "state", "postalCode", "countryCode", "operationHours" ], "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" }, "operationHours": { "type": "array", "items": { "type": "object", "required": [ "dayOfWeekCode", "operationType", "openStrTime", "closeStrTime" ], "properties": { "dayOfWeekCode": { "type": "string" }, "operationType": { "type": "string", "enum": [ "OPR" ] }, "openStrTime": { "type": "string" }, "closeStrTime": { "type": "string" } } } } } }, "destination": { "required": [ "addressLine1", "city", "state", "postalCode", "countryCode" ], "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } } } } }, "unitDetails": { "type": "array", "items": { "type": "object", "required": [ "totalPalletCount", "noOfSingleSkuBoxes", "noOfMixedSkuBoxes", "shipmentPackages" ], "properties": { "declaredValue": { "type": "number" }, "totalPalletCount": { "type": "number" }, "noOfSingleSkuBoxes": { "type": "number" }, "noOfMixedSkuBoxes": { "type": "number" }, "shipmentPackages": { "$ref": "#/components/schemas/wm.LtlShipmentPackage" } } } } } } } } } } ] } } } }, "responses": { "200": { "description": "Get carrier rate quote result", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "header": { "type": "object" }, "payload": { "type": "object" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/wm.Error" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "Walmart", "WFS Shipment" ], "security": [ { "bearer_auth": [] } ] } }, "/api/wm/v3/fulfillment/inbound-shipments-booking?shipmentId={shipmentId}&mode={mode}": { "delete": { "summary": "Cancel Booking", "operationId": "cancelBooking", "description": "Wrapper around Walmart's [Cancel Booking](https://developer.walmart.com/us-marketplace/reference/voidcarrierratequotes) API\n", "parameters": [ { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mode", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Parcel", "LTL" ] } }, { "$ref": "#/components/parameters/x-wm-access-token" } ], "responses": { "200": { "description": "Cancel booking result", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "header": { "type": "object" }, "payload": { "type": "object" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/wm.Error" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "Walmart", "WFS Shipment" ], "security": [ { "bearer_auth": [] } ] } }, "/api/wm/v3/fulfillment/shipment-label": { "post": { "summary": "Create Inbound Shipment Label", "operationId": "createInboundShipmentLabel", "description": "Wrapper around Walmart's [Create Inbound Shipment label](https://developer.walmart.com/us-marketplace/reference/createinboundshipmentlabelv2) API\n", "parameters": [ { "$ref": "#/components/parameters/x-wm-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shipmentId" ], "properties": { "shipmentId": { "type": "string" }, "labelSize": { "type": "string", "enum": [ "X4_6", "X4_3" ] }, "labelFormat": { "type": "string", "enum": [ "PDF", "ZPL" ] }, "loadTypes": { "type": "array", "items": { "type": "object", "properties": { "count": { "type": "integer" }, "loadType": { "type": "string" } } } } } } } }, "required": true }, "responses": { "200": { "description": "Create Inbound Shipment label result", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "application/zpl": { "schema": { "type": "string" } } } }, "400": { "description": "Create Inbound Shipment label errors", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/wm.Error" } } } } } } } }, "tags": [ "Walmart", "WFS Shipment" ], "security": [ { "bearer_auth": [] } ] } }, "/api/wm/v3/fulfillment/inbound-shipments-bol?shipmentId={shipmentId}&mode={mode}": { "get": { "summary": "Print Bill of landing", "operationId": "printBillOfLading", "description": "Wrapper around Walmart's [Print Bill of lading](https://developer.walmart.com/us-marketplace/reference/printbilloflading) API\n", "parameters": [ { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "mode", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "Parcel", " LTL" ] } }, { "$ref": "#/components/parameters/x-wm-access-token" } ], "responses": { "200": { "description": "Print Bill of landing result", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Print Bill of landing errors", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/wm.Error" } } } } } } } }, "tags": [ "Walmart", "WFS Shipment" ], "security": [ { "bearer_auth": [] } ] } }, "/api/wm/v3/fulfillment/carrier-label/{shipmentId}": { "post": { "summary": "Print Walmart Carrier Label", "operationId": "printCarrierLabel", "description": "Wrapper around Walmart's [Print Carrier Label](https://developer.walmart.com/us-marketplace/reference/printcarrierlabel) API\n", "parameters": [ { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-wm-access-token" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shipDate" ], "properties": { "shipDate": { "type": "string", "format": "date-time", "description": "Full timestamp with microsecond precision required", "example": "2025-08-22T00:00:00.000Z" } } } } }, "required": true }, "responses": { "200": { "description": "Print Carrier Label result", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Print Carrier Label errors", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/wm.Error" } } } } } } } }, "tags": [ "Walmart", "WFS Shipment" ], "security": [ { "bearer_auth": [] } ] } }, "/api/wm/v3/fulfillment/inbound-shipment-errors": { "get": { "summary": "Get InboundShipment Errors", "operationId": "getInboundShipmentErrors", "description": "Wrapper around Walmart's [Get Inbound Shipment errors](https://developer.walmart.com/us-marketplace/reference/getinboundordererrors) API\n", "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "string", "default": "0" } }, { "name": "limit", "in": "query", "schema": { "type": "string", "default": "10" } }, { "name": "inboundOrderId", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-wm-access-token" } ], "responses": { "200": { "description": "Get Inbound Shipment errors response", "content": { "application/json": { "schema": { "type": "object", "properties": { "headers": { "type": "object", "properties": { "totalCount": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } }, "payload": { "type": "array", "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "returnAddress": { "$ref": "#/components/schemas/wm.Address" }, "orderItems": { "type": "array", "items": { "$ref": "#/components/schemas/wm.OrderItem" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/wm.Error" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "Walmart", "WFS Shipment" ], "security": [ { "bearer_auth": [] } ] } }, "/api/wm/v3/fulfillment/inbound-shipment-items": { "get": { "summary": "Get InboundShipment Items", "operationId": "getInboundShipmentItems", "description": "Wrapper around Walmart's [Get Inbound Shipment Items](https://developer.walmart.com/us-marketplace/reference/getinboundshipmentitems) API\n", "parameters": [ { "name": "offset", "in": "query", "schema": { "type": "string", "default": "0" } }, { "name": "limit", "in": "query", "schema": { "type": "string", "default": "10" } }, { "name": "shipmentId", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-wm-access-token" } ], "responses": { "200": { "description": "Get Inbound Shipment Items response", "content": { "application/json": { "schema": { "type": "object", "properties": { "headers": { "type": "object", "properties": { "totalCount": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } } }, "payload": { "type": "array", "items": { "type": "object", "properties": { "inboundOrderId": { "type": "string" }, "shipmentId": { "type": "string" }, "gtin": { "type": "string" }, "sku": { "type": "string" }, "itemDesc": { "type": "string" }, "itemQty": { "type": "integer" }, "vendorPackQty": { "type": "integer" }, "innerPackQty": { "type": "integer" }, "receivedQty": { "type": "integer" }, "damagedQty": { "type": "integer" }, "fillRate": { "type": "number" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "updatedExpectedDeliveryDate": { "type": "string", "format": "date-time" }, "shipNodeName": { "type": "string" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "Walmart", "WFS Shipment" ], "security": [ { "bearer_auth": [] } ] } }, "/api/wm/v3/fulfillment/inbound-shipments/{inboundOrderId}": { "delete": { "summary": "Cancel InboundShipment", "operationId": "cancelInboundShipment", "description": "Wrapper around Walmart's [Cancel Inbound Shipment](https://developer.walmart.com/us-marketplace/reference/cancelshipment) API\n", "parameters": [ { "name": "inboundOrderId", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-wm-access-token" } ], "responses": { "200": { "description": "Cancel Inbound Shipment response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "header": { "type": "object" }, "payload": { "type": "object" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/wm.Error" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "tags": [ "Walmart", "WFS Shipment" ], "security": [ { "bearer_auth": [] } ] } }, "/api/v2/prep-matrix/product": { "get": { "tags": [ "Prep Billing" ], "summary": "Get all Prep Matrix Product mappings", "description": "Retrieve a list of prep_matrix_products with optional filters", "operationId": "selectPrepMatrixProducts", "parameters": [ { "name": "prep_matrix_id", "in": "query", "description": "Filter by prep_matrix_id", "required": false, "schema": { "type": "string" } }, { "name": "prep_matrix_name", "in": "query", "description": "Filter by prep_matrix name", "required": false, "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "Filter by external ID", "required": false, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Filter by client ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_products": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/PrepMatrixProduct" }, { "$ref": "#/components/schemas/PrepMatrix" } ] } }, "total_rows": { "type": "integer" } } } } } }, "404": { "$ref": "#/components/responses/404" } }, "security": [ { "bearer_auth": [] } ] }, "put": { "tags": [ "Prep Billing" ], "summary": "Create multiple Prep Matrix Product mappings", "description": "Insert one or more prep_matrix_product records", "operationId": "insertPrepMatrixProducts", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_products": { "type": "array", "items": { "$ref": "#/components/schemas/NewPrepMatrixProduct" } } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_products": { "type": "array", "items": { "$ref": "#/components/schemas/PrepMatrixProduct" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/v2/prep-matrix/product/{external_id}": { "get": { "tags": [ "Prep Billing" ], "summary": "Get a specific Prep Matrix Product mapping by external_id", "description": "Retrieve a prep_matrix_product by its external_id", "operationId": "selectPrepMatrixProduct", "parameters": [ { "name": "external_id", "in": "path", "description": "External ID of the prep_matrix_product", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_product": { "$ref": "#/components/schemas/PrepMatrixProduct" } } } } } }, "404": { "description": "Not found" } }, "security": [ { "bearer_auth": [] } ] }, "patch": { "tags": [ "Prep Billing" ], "summary": "Update a Prep Matrix Product mapping by external_id", "description": "Update a prep_matrix_product by its external_id", "operationId": "updatePrepMatrixProducts", "parameters": [ { "name": "external_id", "in": "path", "description": "A comma separated list of external IDs. Each matching item will be updated with the data in the request body", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_id": { "format": "int64", "type": "integer", "description": "Unique ID for the prep_matrix_name" }, "prep_matrix_name": { "type": "string", "description": "What preparations need to be made, eg 'Bubblewrap', 'Security + Label', etc." }, "deleted": { "type": "null", "description": "`null` may be passed to un-delete a previously deleted prep_matrix_product" } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_products": { "type": "array", "items": { "$ref": "#/components/schemas/PrepMatrixProduct" } } } } } } }, "404": { "description": "Not found" } }, "security": [ { "bearer_auth": [] } ] }, "delete": { "tags": [ "Prep Billing" ], "summary": "Delete one or more Prep Matrix Product mapping by external_id", "description": "Delete one or more prep_matrix_product by external_id", "operationId": "deletePrepMatrixProducts", "parameters": [ { "name": "external_id", "in": "path", "description": "Comma separated list of external IDs", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_products": { "type": "array", "items": { "type": "object", "properties": { "external_id": { "type": "string", "description": "ASIN for Amazon items, itemId for Walmart items" }, "deleted": { "type": "string", "format": "date-time", "description": "Timestamp when the record was deleted" } } } } } } } } }, "404": { "description": "Not found" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/v2/prep-matrix": { "get": { "tags": [ "Prep Billing" ], "summary": "Get all Prep Matrices", "description": "Retrieve a list of prep_matrices with optional filters", "operationId": "selectPrepMatrices", "parameters": [ { "name": "prep_matrix_id", "in": "query", "description": "Filter by prep_matrix_id", "required": false, "schema": { "type": "string" } }, { "name": "prep_matrix_name", "in": "query", "description": "Filter by prep_matrix name", "required": false, "schema": { "type": "string" } }, { "name": "ad_hoc", "in": "query", "description": "Filter by ad_hoc", "required": false, "schema": { "type": "boolean" } }, { "name": "prep_matrix_category_ids", "in": "query", "description": "Comma separated list of category ids to filter by", "required": false, "schema": { "type": "string" } }, { "name": "prep_matrix_category_names", "in": "query", "description": "Comma separated list of category names to filter by. If a name has a comma in it, wrap it with quotes", "required": false, "schema": { "type": "string" } }, { "name": "client_ids", "in": "query", "description": "A comma separated list of client user ids (UUID). Can also pass `null` as one of the values to return records with a null client_id.", "required": false, "example": "2f16c5b2-97d3-4238-8b89-22851363bf27,null", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrices": { "type": "array", "items": { "$ref": "#/components/schemas/PrepMatrix" } }, "total_rows": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "put": { "tags": [ "Prep Billing" ], "summary": "Create multiple Prep Type matrices", "description": "Insert multiple prep_matrices", "operationId": "insertPrepMatrices", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrices": { "type": "array", "items": { "$ref": "#/components/schemas/NewPrepMatrix" } } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrices": { "type": "array", "items": { "$ref": "#/components/schemas/PrepMatrix" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/v2/prep-matrix/prep-tier": { "get": { "tags": [ "Prep Billing" ], "summary": "Get all Prep Tiers", "description": "Retrieve a list of prep tiers", "operationId": "selectPrepTiers", "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_tiers": { "type": "array", "items": { "$ref": "#/components/schemas/PrepTier" } }, "total_rows": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "put": { "tags": [ "Prep Billing" ], "summary": "Create one or more prep tiers", "description": "Insert multiple prep_tiers", "operationId": "insertPrepTiers", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_tiers": { "type": "array", "items": { "$ref": "#/components/schemas/NewPrepTier" } } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_tiers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/PrepTier" }, { "type": "object", "properties": { "prep_matrix_tiers": { "type": "array", "items": { "$ref": "#/components/schemas/PrepMatrixTier" } }, "prep_client_tiers": { "type": "array", "items": { "$ref": "#/components/schemas/PrepClientTier" } } } } ] } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/v2/prep-matrix/prep-tier/{prep_tier_ids}": { "patch": { "tags": [ "Prep Billing" ], "summary": "Update one or more Prep Tiers", "description": "Update multiple prep tiers", "operationId": "updatePrepTiers", "parameters": [ { "name": "prep_tier_ids", "in": "path", "description": "Comma separated list of prep_tier ids to update", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_tier": { "type": "object", "properties": { "prep_tier_name": { "type": "string" }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" }, "prep_tier_type": { "type": "string", "enum": [ "unit", "weight" ] }, "bill_for_packed_boxes": { "type": "boolean" } } } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_tiers": { "type": "array", "items": { "$ref": "#/components/schemas/PrepTier" } }, "total_rows": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "delete": { "tags": [ "Prep Billing" ], "summary": "Delete one or more prep tiers", "description": "Delete multiple prep_tiers", "operationId": "deletePrepTiers", "parameters": [ { "name": "prep_tier_ids", "in": "path", "description": "Comma separated list of prep_tier ids to update", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_tiers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/PrepTier" }, { "type": "object", "properties": { "deleted": { "type": "string", "format": "date-time" } } } ] } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/v2/prep-matrix/category": { "get": { "tags": [ "Prep Billing" ], "summary": "Get all prep matrix categories", "description": "Retrieve a list of prep_matrix_categories with optional filters", "operationId": "selectPrepMatrixCategories", "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_categories": { "type": "array", "items": { "$ref": "#/components/schemas/PrepMatrixCategory" } }, "total_rows": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "put": { "tags": [ "Prep Billing" ], "summary": "Create one or more prep categories", "description": "Insert multiple prep_matrix_category records", "operationId": "insertPrepMatrixCategories", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_category_names": { "type": "array", "items": { "type": "string" } } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_categories": { "type": "array", "items": { "$ref": "#/components/schemas/PrepMatrixCategory" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/v2/prep-matrix/category/{prep_matrix_category_id}": { "patch": { "tags": [ "Prep Billing" ], "summary": "Update a prep matrix category name", "description": "Update a single prep_matrix_category by id", "operationId": "updatePrepMatrixCategory", "parameters": [ { "name": "prep_matrix_category_id", "in": "path", "description": "ID of the prep_matrix_category to update", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_category_name": { "type": "string", "description": "The new prep matrix category name" } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_category": { "$ref": "#/components/schemas/PrepMatrixCategory" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "delete": { "tags": [ "Prep Billing" ], "summary": "Delete one or more prep categories", "description": "Delete multiple prep_matrix_category records", "operationId": "deletePrepMatrixCategories", "parameters": [ { "name": "prep_matrix_category_id", "in": "path", "description": "Comma separated list of the prep_matrix_category ids to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_categories": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/PrepMatrixCategory" }, { "type": "object", "properties": { "deleted": { "type": "string", "format": "date-time" } } } ] } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/v2/prep-matrix/report": { "get": { "tags": [ "Prep Billing" ], "summary": "Get the billing report for a given time period", "description": "Get the billing report for a given time period", "operationId": "prepCenterBillingReport", "parameters": [ { "name": "start", "in": "query", "description": "Start date in ISO 8601 format", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "description": "Optional end date in ISO 8601 format", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "client_ids", "in": "query", "description": "A comma separated list of client user ids.", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "detail", "in": "query", "description": "Pass this parameter to generate a detailed report. Only when requesting spreadsheet output.", "required": false, "schema": { "type": "string", "enum": [ "1" ] } }, { "in": "header", "name": "Accept", "description": "Specify `text/csv` or `application/vnd.ms-excel` to generate CSV or XLSX formats respectively.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "text/csv", "application/vnd.ms-excel" ] } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepBillingReportResponse" } }, "text/csv": { "schema": { "type": "string" } }, "application/vnd.ms-excel": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "post": { "tags": [ "Prep Billing" ], "summary": "Get the billing report for a given time period", "description": "Get the billing report for a given time period", "operationId": "prepCenterBillingReportPost", "parameters": [ { "in": "header", "name": "Accept", "description": "Specify `text/csv` or `application/vnd.ms-excel` to generate CSV or XLSX formats respectively.", "required": false, "schema": { "type": "string", "enum": [ "application/json", "text/csv", "application/vnd.ms-excel" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix": { "type": "object", "required": [ "start" ], "properties": { "start": { "description": "Start date in ISO 8601 format", "type": "string", "format": "date-time" }, "end": { "description": "Optional end date in ISO 8601 format", "type": "string", "format": "date-time" }, "client_ids": { "description": "A list of client user ids.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "detail": { "type": "boolean", "description": "Pass `true` to generate a detailed report. Only when requesting spreadsheet output." } } } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepBillingReportResponse" } }, "text/csv": { "schema": { "type": "string" } }, "application/vnd.ms-excel": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/v2/prep-matrix/ad_hoc": { "get": { "tags": [ "Prep Billing" ], "summary": "Get ad hoc charges", "description": "Get ad hoc charges", "operationId": "selectAdHocPrepMatrices", "parameters": [ { "name": "client_ids", "in": "query", "description": "A comma separated list of client user ids.", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "batch_id", "in": "query", "description": "A single Amazon batch id.", "required": false, "schema": { "type": "string" } }, { "name": "shipment_ids", "in": "query", "description": "A comma separated list of Amazon shipment confirmation ids.", "required": false, "schema": { "type": "string" } }, { "name": "wm_shipment_ids", "in": "query", "description": "A comma separated list of Walmart shipment ids.", "required": false, "schema": { "type": "string" } }, { "name": "batch_ids", "in": "query", "description": "A comma separated list of Amazon batch ids.", "required": false, "schema": { "type": "string" } }, { "name": "v2_batch_ids", "in": "query", "description": "A comma separated list of Walmart batch ids.", "required": false, "schema": { "type": "string" } }, { "name": "purchase_order_ids", "in": "query", "description": "A comma separated list of purchase order ids.", "required": false, "schema": { "type": "string" } }, { "name": "prep_matrix_ids", "in": "query", "description": "A comma separated list of prep matrix ids.", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "prep_matrix_categories", "in": "query", "description": "A comma separated list of prep matrix categories.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdHocPrepMatrixResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "post": { "tags": [ "Prep Billing" ], "summary": "Get ad hoc charges", "description": "Get ad hoc charges", "operationId": "selectAdHocPrepMatricesPost", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "client_ids": { "description": "A list of client user ids.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "batch_id": { "description": "A single Amazon batch id", "type": "string" }, "shipment_ids": { "description": "A list of Amazon shipment confirmation ids.", "type": "array", "items": { "type": "string" } }, "wm_shipment_ids": { "description": "A list of Walmart shipment ids.", "type": "array", "items": { "type": "string" } }, "batch_ids": { "description": "A list of Amazon batch ids.", "type": "array", "items": { "type": "string" } }, "v2_batch_ids": { "description": "A list of Walmart batch ids.", "type": "array", "items": { "type": "string" } }, "purchase_order_ids": { "description": "A list of purchase order ids.", "type": "array", "items": { "type": "string" } }, "prep_matrix_ids": { "description": "A list of prep matrix ids.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "prep_matrix_names": { "description": "A list of prep matrix names.", "type": "array", "items": { "type": "string" } } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdHocPrepMatrixResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "put": { "tags": [ "Prep Billing" ], "summary": "Add one or more ad hoc charges", "description": "Add one or more ad hoc charges", "operationId": "insertAdHocPrepMatrices", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ad_hoc_prep_matrices": { "type": "array", "items": { "type": "object", "properties": { "shipment_id": { "type": "string", "description": "The id of the Amazon shipment to add charges to" }, "batch_id": { "type": "string", "description": "The id of the Amazon batch to add charges to" }, "wm_shipment_id": { "type": "string", "description": "The id of the Walmart shipment to add charges to" }, "v2_batch_id": { "type": "string", "description": "The id of the Walmart batch to add charges to" }, "purchase_order_id": { "type": "string", "description": "The id of the purchase order to add charges to" }, "prep_matrix_id": { "type": "integer", "format": "int64", "description": "Specify a charge either by the id or the name" }, "prep_matrix_name": { "type": "string", "description": "Specify a charge either by the id or the name" }, "quantity": { "type": "integer", "description": "Optional quantity to add, defaults to 1" } } } } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "shipment_prep_matrices": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "integer", "description": "The price, in the smallest currency unit. For example $5.00 will be `500`" }, "currency_code": { "type": "string" }, "shipment_id": { "type": "string" }, "wm_shipment_id": { "type": "string" }, "batch_id": { "type": "string" }, "v2_batch_id": { "type": "string" }, "purchase_order_id": { "type": "string" }, "prep_matrix_id": { "type": "integer", "format": "int64" }, "prep_matrix_name": { "type": "string" }, "quantity": { "type": "integer" } } } }, "errors": { "type": "array", "items": { "type": "object" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "patch": { "tags": [ "Prep Billing" ], "summary": "Update or delete one or more ad hoc charges", "description": "Update or delete one or more ad hoc charges", "operationId": "updateAdHocPrepMatrices", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ad_hoc_prep_matrices": { "type": "array", "items": { "type": "object", "properties": { "shipment_id": { "type": "string" }, "wm_shipment_id": { "type": "string" }, "batch_id": { "type": "string" }, "v2_batch_id": { "type": "string" }, "purchase_order_id": { "type": "string" }, "prep_matrix_id": { "type": "integer", "format": "int64", "description": "Specify a charge either by the id or the name" }, "prep_matrix_name": { "type": "string", "description": "Specify a charge either by the id or the name" }, "quantity": { "type": "integer", "description": "Update the quantity to this amount" }, "deleted": { "type": "boolean", "description": "Pass `true` to delete this charge" } } } } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "shipment_prep_matrices": { "type": "array", "items": { "type": "object", "properties": { "shipment_id": { "type": "string" }, "wm_shipment_id": { "type": "string" }, "batch_id": { "type": "string" }, "v2_batch_id": { "type": "string" }, "purchase_order_id": { "type": "string" }, "prep_matrix_id": { "type": "integer", "format": "int64" }, "quantity": { "type": "integer" } } } }, "errors": { "type": "array", "items": { "type": "object" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/v2/prep-matrix/tier": { "get": { "tags": [ "Prep Billing" ], "summary": "Get all Prep Matrix Tiers", "description": "Prep matrix tiers are mapping of prep types to tiers along with the price and currency code", "operationId": "selectPrepMatrixTiers", "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_tiers": { "type": "array", "items": { "$ref": "#/components/schemas/PrepMatrixTier" } }, "total_rows": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "put": { "tags": [ "Prep Billing" ], "summary": "Create one or more prep matrix tiers", "description": "Insert multiple prep_matrix_tiers", "operationId": "insertPrepMatrixTiers", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_tiers": { "type": "array", "items": { "$ref": "#/components/schemas/NewPrepMatrixTier" } } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_tiers": { "type": "array", "items": { "$ref": "#/components/schemas/PrepMatrixTier" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "patch": { "tags": [ "Prep Billing" ], "summary": "Update one or more prep matrix tiers", "description": "Update multiple prep_matrix_tiers", "operationId": "updatePrepMatrixTiers", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_tiers": { "type": "array", "items": { "$ref": "#/components/schemas/UpdatePrepMatrixTier" } } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix_tiers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/PrepMatrixTier" }, { "type": "object", "properties": { "deleted": { "type": "string", "format": "date-time" } } } ] } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/v2/prep-matrix/client-tier": { "get": { "tags": [ "Prep Billing" ], "summary": "Get all Prep Client Tiers", "description": "Retrieve a list of prep client tiers with optional filters", "operationId": "selectPrepClientTiers", "parameters": [ { "name": "client_ids", "in": "query", "description": "A comma separated list of client user ids.", "required": false, "schema": { "type": "string", "format": "uuid" } }, { "name": "prep_tier_ids", "in": "query", "description": "A comma separated list of prep tier ids.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_client_tiers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/PrepClientTier" }, { "type": "object", "properties": { "prep_tier_name": { "type": "string" }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" }, "prep_tier_type": { "type": "string", "enum": [ "unit", "weight" ] }, "name": { "type": "string", "description": "The client name" }, "business": { "type": "string", "description": "The client business name" } } } ] } }, "total_rows": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/v2/prep-matrix/client-tier/{client_ids}": { "put": { "tags": [ "Prep Billing" ], "summary": "Create one or more prep client tiers", "description": "Insert multiple prep_client_tiers", "operationId": "insertPrepClientTiers", "parameters": [ { "name": "client_ids", "in": "path", "description": "Comma separated list of client ids", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_tier_id": { "type": "integer", "format": "int64", "description": "Either this or prep_tier_name is required" }, "prep_tier_name": { "type": "string", "description": "Either this or prep_tier_id is required" } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_client_tiers": { "type": "array", "items": { "$ref": "#/components/schemas/PrepClientTier" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "patch": { "tags": [ "Prep Billing" ], "summary": "Update one or more prep client tiers", "description": "Update multiple prep_client_tiers", "operationId": "updatePrepClientTiers", "parameters": [ { "name": "client_ids", "in": "path", "description": "Comma separated list of client ids", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_tier_id": { "type": "integer", "format": "int64", "description": "Either this or prep_tier_name is required" }, "prep_tier_name": { "type": "string", "description": "Either this or prep_tier_id is required" } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_client_tiers": { "type": "array", "items": { "$ref": "#/components/schemas/PrepClientTier" } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] }, "delete": { "tags": [ "Prep Billing" ], "summary": "Delete one or more prep client tiers", "description": "Delete multiple prep_client_tiers", "operationId": "deletePrepClientTiers", "parameters": [ { "name": "client_ids", "in": "path", "description": "Comma separated list of client ids", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_client_tiers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/PrepClientTier" }, { "type": "object", "properties": { "deleted": { "type": "string", "format": "date-time" } } } ] } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/v2/prep-matrix/{prep_matrix_id}": { "get": { "tags": [ "Prep Billing" ], "summary": "Get a specific Prep Type Matrix by ID", "description": "Retrieve a prep_matrix by its ID", "operationId": "selectPrepMatrix", "parameters": [ { "name": "prep_matrix_id", "in": "path", "description": "ID of the prep_matrix", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix": { "$ref": "#/components/schemas/PrepMatrix" } } } } } }, "404": { "description": "Not found" } }, "security": [ { "bearer_auth": [] } ] }, "patch": { "tags": [ "Prep Billing" ], "summary": "Update one or more Prep Type Matrices by ID", "description": "Update one or more prep_matrices by its ID", "operationId": "updatePrepMatrices", "parameters": [ { "name": "prep_matrix_id", "in": "path", "description": "Comma separated list of Prep Type Matrix IDs", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrix": { "type": "object", "properties": { "prep_matrix_name": { "type": "string", "description": "What preparations need to be made, eg 'Bubblewrap', 'Security + Label', etc." }, "ad_hoc": { "type": "boolean" }, "price": { "type": "integer", "description": "The price, in the smallest currency unit, per unit to charge for prep. For example $5.00 will be `500`" }, "currency_code": { "type": "string", "description": "The currency that the price will be charged in. Eg. USD, EUR, etc." }, "prep_matrix_category_id": { "type": "integer", "format": "int64", "description": "The prep matrix category id" }, "prep_matrix_category_name": { "type": "string", "description": "The prep matrix category name" }, "client_id": { "type": "string" } } } } } } }, "required": true }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrices": { "type": "array", "items": { "$ref": "#/components/schemas/PrepMatrix" } } } } } } }, "404": { "description": "Not found" } }, "security": [ { "bearer_auth": [] } ] }, "delete": { "tags": [ "Prep Billing" ], "summary": "Delete one or more Prep Type Matrices by ID", "description": "Delete one or more prep_matrices by ID", "operationId": "deletePrepMatrices", "parameters": [ { "name": "prep_matrix_id", "in": "path", "description": "Comma seprated list of prep_matrix IDs", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "prep_matrices": { "type": "array", "items": { "type": "object", "properties": { "prep_matrix_id": { "format": "int64", "type": "integer" }, "deleted": { "type": "string", "format": "date-time", "description": "Timestamp when the record was deleted" } } } } } } } } }, "404": { "description": "Not found" } }, "security": [ { "bearer_auth": [] } ] } }, "/api/v2/inbound-plan": { "get": { "summary": "Get the inbound plan(s) for a batch or shipment", "description": "Get the inbound plan(s) for a batch or shipment", "operationId": "selectInboundPlans", "parameters": [ { "in": "query", "name": "v1_batch_id", "schema": { "type": "string" } }, { "in": "query", "name": "v2_batch_id", "schema": { "type": "string" } }, { "in": "query", "name": "shipment_id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "inbound_plans": { "items": { "$ref": "#/components/schemas/inbound_plan" }, "type": "array" }, "total_rows": { "description": "The total number of inbound plans that could be returned", "type": "integer" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ] } }, "/api/v2/inbound-plan/{inbound_plan_id}": { "get": { "description": "Get an inbound plan by id", "operationId": "selectInboundPlan", "parameters": [ { "in": "path", "name": "inbound_plan_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "inbound_plan": { "$ref": "#/components/schemas/inbound_plan" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Get an inbound plan by id" }, "patch": { "description": "Update an InboundPlan", "operationId": "updateInboundPlan", "parameters": [ { "in": "path", "name": "inbound_plan_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbound_plan_input" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "inbound_plan": { "$ref": "#/components/schemas/inbound_plan" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Update an InboundPlan" } }, "/api/v2/inbound-plan/{inbound_plan_id}/packing-options": { "get": { "description": "Load the packing options for a given inbound plan", "operationId": "selectPackingOptions", "parameters": [ { "in": "path", "name": "inbound_plan_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "packing_options": { "items": { "$ref": "#/components/schemas/packing_option" }, "type": "array" }, "total_rows": { "description": "The total number of packing options that could be returned", "type": "integer" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Load the packing options for a given Inbound Plan" } }, "/api/v2/inbound-plan/{inbound_plan_id}/placement-options": { "get": { "description": "Load the placement options for a given inbound plan", "operationId": "selectPlacementOptions", "parameters": [ { "in": "path", "name": "inbound_plan_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "placement_options": { "items": { "$ref": "#/components/schemas/placement_option" }, "type": "array" }, "total_rows": { "description": "The total number of placement options that could be returned", "type": "integer" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Load Placement Options for a given Inbound Plan" } }, "/api/v2/inbound-plan/{inbound_plan_id}/placement-options/{placement_option_id}/transportation-options": { "get": { "summary": "Load the Transportation Options for a given Inbound Plan and Placement Option", "description": "Load the transportation options for a given inbound plan and placement option", "operationId": "selectTransportationOptions", "parameters": [ { "in": "path", "name": "inbound_plan_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "placement_option_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "shipment_id", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "total_rows": { "description": "The total number of transportation options that could be returned", "type": "integer" }, "transportation_options": { "items": { "$ref": "#/components/schemas/transportation_option" }, "type": "array" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ] } }, "/api/v2/inbound-plan/{inbound_plan_id}/placement-options/{placement_option_id}/transportation-options/{transportation_option_id}": { "get": { "summary": "Select Transportation Option by Id", "description": "Load the given transportation option by id", "operationId": "selectTransportationOption", "parameters": [ { "in": "path", "name": "inbound_plan_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "placement_option_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "transportation_option_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "transportation_option": { "$ref": "#/components/schemas/transportation_option" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ] }, "patch": { "description": "Load the given transportation option by id", "operationId": "updateTransportationOption", "parameters": [ { "in": "path", "name": "inbound_plan_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "placement_option_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "transportation_option_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transportation_option_input" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "transportation_option": { "$ref": "#/components/schemas/transportation_option" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ] }, "put": { "summary": "Load the given Transportation Option by Id", "description": "Load the given transportation option by id", "operationId": "insertTransportationOption", "parameters": [ { "in": "path", "name": "inbound_plan_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "placement_option_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "transportation_option_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transportation_option_input" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "transportation_option": { "$ref": "#/components/schemas/transportation_option" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ] } }, "/api/v2/inbound-plan/{inbound_plan_id}/shipments": { "get": { "summary": "Get AZ shipments saved in the database", "description": "Get AZ shipments from the database", "operationId": "selectShipments", "parameters": [ { "in": "path", "name": "inbound_plan_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "shipments": { "items": { "$ref": "#/components/schemas/shipment" }, "type": "array" }, "total_rows": { "type": "integer" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ] } }, "/api/v2/inbound-plan/{inbound_plan_id}/shipments/{shipment_id}/delivery-window-options": { "get": { "description": "Get AZ delivery window options from the database", "operationId": "selectDeliveryWindowOptions", "parameters": [ { "in": "path", "name": "inbound_plan_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipment_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "delivery_window_options": { "items": { "$ref": "#/components/schemas/v2.delivery_window_option" }, "type": "array" }, "total_rows": { "type": "integer" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Get AZ delivery window options from the database" } }, "/api/v2/inbound-plan/{inbound_plan_id}/shipments/{shipment_id}/delivery-window-options/{delivery_window_option_id}": { "get": { "description": "Get an AZ delivery window option from the database", "operationId": "selectDeliveryWindowOption", "parameters": [ { "in": "path", "name": "inbound_plan_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipment_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "delivery_window_option_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "delivery_window_option": { "$ref": "#/components/schemas/v2.delivery_window_option" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Get an AZ delivery window option from the database" }, "patch": { "description": "Update a delivery window option in our database", "operationId": "updateDeliveryWindowOption", "parameters": [ { "in": "path", "name": "inbound_plan_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipment_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "delivery_window_option_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2.delivery_window_option_input" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "delivery_window_option": { "$ref": "#/components/schemas/v2.delivery_window_option" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Update a delivery window option in our database" }, "put": { "description": "Insert a delivery window option into our database", "operationId": "insertDeliveryWindowOption", "parameters": [ { "in": "path", "name": "inbound_plan_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "shipment_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "delivery_window_option_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2.delivery_window_option_input" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "delivery_window_option": { "$ref": "#/components/schemas/v2.delivery_window_option" } }, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" } }, "security": [ { "bearer_auth": [] } ], "tags": [ "FBA Inbound Shipment", "Amazon" ], "summary": "Insert a delivery window option into our database" } } }, "components": { "headers": { "x-request-id": { "description": "A unique ID for this request. When the response is sent through pubsub, it will contain this ID.", "schema": { "type": "string" } } }, "parameters": { "allPages": { "description": "Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.", "in": "query", "name": "allPages", "schema": { "enum": [ 1 ], "example": 1, "type": "integer" } }, "list": { "description": "When the options have been generated, this parameter will tell the server to list those options and save them to the database before returning a success response.", "in": "query", "name": "list", "schema": { "enum": [ 1 ], "example": 1, "type": "integer" } }, "operationComplete": { "description": "Repeatedly poll `getInboundOperationStatus` on the returned `operationId` until the operation finishes and return the results of that instead of just the `operationId`.", "in": "query", "name": "operationComplete", "schema": { "enum": [ 1 ], "example": 1, "type": "integer" } }, "spapi.pageSize": { "in": "query", "name": "pageSize", "schema": { "example": 10, "type": "integer" } }, "x-access-token": { "description": "An Amazon API access token", "in": "header", "name": "x-access-token", "required": true, "schema": { "type": "string" } }, "x-wm-access-token": { "description": "A Walmart API access token", "in": "header", "name": "x-wm-access-token", "required": true, "schema": { "type": "string" } } }, "responses": { "202": { "description": "The operation took more than 5 seconds to complete. An `x-request-id` header is returned that can be used to identify the corresponding pubsub notification that will be sent when the operation completes.", "headers": { "x-request-id": { "$ref": "#/components/headers/x-request-id" } } }, "400": { "description": "Bad Request - The request was invalid or cannot be served", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/spapi.Error" } } } } } } }, "401": { "description": "Unauthorized - Authentication credentials were missing or incorrect", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/spapi.Error" } } } } } } }, "403": { "description": "Forbidden - The request is understood, but it has been refused or access is not allowed", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/spapi.Error" } } } } } } }, "404": { "description": "Not Found - The requested resource could not be found", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/spapi.Error" } } } } } } }, "422": { "description": "Unprocessable Entity - The request was well-formed but was unable to be followed due to semantic errors", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/spapi.Error" } } } } } } }, "429": { "description": "Too Many Requests - Rate limit exceeded", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/spapi.Error" } } } } } } } }, "schemas": { "MarketplaceId": { "description": "[Marketplace ID](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids)", "example": "ATVPDKIKX0DER", "type": "string" }, "spapi.Address": { "$ref": "#/components/schemas/Address" }, "spapi.AddressInput": { "description": "[AddressInput](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#addressinput)", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "companyName": { "type": "string" }, "countryCode": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "phoneNumber": { "type": "string" }, "postalCode": { "type": "string" }, "stateOrProvinceCode": { "type": "string" } }, "type": "object" }, "spapi.AppointmentSlotTime": { "description": "[AppointmentSlotTime](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#appointmentslottime)", "properties": { "endTime": { "type": "string" }, "startTime": { "type": "string" } }, "type": "object" }, "spapi.Box": { "$ref": "#/components/schemas/Box" }, "spapi.BoxInput": { "$ref": "#/components/schemas/BoxInput" }, "spapi.BoxUpdateInput": { "$ref": "#/components/schemas/BoxUpdateInput" }, "spapi.ContactInformation": { "$ref": "#/components/schemas/ContactInformation" }, "spapi.Currency": { "$ref": "#/components/schemas/Currency" }, "spapi.Dimensions": { "$ref": "#/components/schemas/Dimensions" }, "spapi.DocumentDownload": { "description": "[DocumentDownload](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#documentdownload)", "properties": { "downloadType": { "type": "string" }, "expiration": { "type": "string" }, "uri ": { "type": "string" } }, "type": "object" }, "spapi.Error": { "description": "[Error](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v0-reference#error)", "properties": { "code": { "type": "string" }, "details": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "spapi.FreightInformation": { "$ref": "#/components/schemas/FreightInformation" }, "spapi.InboundOperationStatus": { "$ref": "#/components/schemas/InboundOperationStatus" }, "spapi.Incentive": { "description": "[Incentive](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#incentive)", "properties": { "description": { "type": "string" }, "target": { "type": "string" }, "type": { "enum": [ "FEE", "DISCOUNT" ], "type": "string" }, "value": { "$ref": "#/components/schemas/Currency" } }, "type": "object" }, "spapi.Item": { "$ref": "#/components/schemas/Item" }, "spapi.ItemInput": { "$ref": "#/components/schemas/ItemInput" }, "spapi.OwnerConstraint": { "description": "[OwnerConstraint](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#ownerconstraint)", "enum": [ "AMAZON_ONLY", "NONE_ONLY", "SELLER_ONLY" ], "type": "string" }, "spapi.PackingOption": { "description": "[PackingOption](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#packingoption)", "properties": { "discounts": { "items": { "$ref": "#/components/schemas/spapi.Incentive" }, "type": "array" }, "expiration": { "type": "string" }, "fees": { "items": { "$ref": "#/components/schemas/spapi.Incentive" }, "type": "array" }, "packingGroups": { "items": { "type": "string" }, "type": "array" }, "packingOptionId": { "type": "string" }, "status": { "enum": [ "OFFERED", "ACCEPTED", "EXPIRED" ], "type": "string" }, "supportedShippingConfigurations": { "items": { "description": "[ShippingConfiguration](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#shippingconfiguration)", "properties": { "shippingMode": { "$ref": "#/components/schemas/shippingMode" }, "shippingSolution": { "enum": [ "AMAZON_PARTNERED_CARRIER", "USE_YOUR_OWN_CARRIER" ], "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "spapi.Pagination": { "$ref": "#/components/schemas/Pagination" }, "spapi.Pallet": { "description": "[Pallet](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#pallet)", "properties": { "dimensions": { "$ref": "#/components/schemas/Dimensions" }, "packageId": { "type": "string" }, "quantity": { "type": "integer" }, "stackability": { "$ref": "#/components/schemas/Stackability" }, "weight ": { "$ref": "#/components/schemas/Weight" } }, "type": "object" }, "spapi.PlacementOption": { "description": "[PlacementOption](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#placementoption)", "properties": { "discounts": { "items": { "$ref": "#/components/schemas/spapi.Incentive" }, "type": "array" }, "expiration": { "type": "string" }, "fees": { "items": { "$ref": "#/components/schemas/spapi.Incentive" }, "type": "array" }, "placementOptionId": { "type": "string" }, "shipmentIds": { "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "OFFERED", "ACCEPTED", "EXPIRED" ], "type": "string" } }, "type": "object" }, "spapi.PrepCategory": { "description": "[PrepCategory](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#prepcategory)", "enum": [ "ADULT", "BABY", "FC_PROVIDED", "FRAGILE", "GRANULAR", "HANGER", "LIQUID", "PERFORATED", "SET", "SHARP", "SMALL", "TEXTILE", "UNKNOWN", "NONE" ], "type": "string" }, "spapi.PrepOwner": { "$ref": "#/components/schemas/PrepOwner" }, "spapi.PrepType": { "description": "[PrepType](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#preptype)", "enum": [ "ITEM_BLACK_SHRINKWRAP", "ITEM_BLANKSTK", "ITEM_BOXING", "ITEM_BUBBLEWRAP", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_HANG_GARMENT", "ITEM_LABELING", "ITEM_NO_PREP", "ITEM_POLYBAGGING", "ITEM_RMOVHANG", "ITEM_SETCREAT", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_SUFFOSTK", "ITEM_TAPING" ], "type": "string" }, "spapi.RequestedUpdates": { "description": "[RequestedUpdates](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#requestedupdates)", "properties": { "boxes": { "items": { "$ref": "#/components/schemas/BoxUpdateInput" }, "type": "array" }, "items": { "items": { "$ref": "#/components/schemas/ItemInput" }, "type": "array" } }, "type": "object" }, "spapi.Shipment": { "$ref": "#/components/schemas/Shipment" }, "spapi.Stackability": { "$ref": "#/components/schemas/Stackability" }, "spapi.TaxDetails": { "description": "[TaxDetails](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#taxdetails)", "properties": { "declaredValue": { "$ref": "#/components/schemas/Currency" }, "hsnCode": { "type": "string" }, "taxRates": { "items": { "description": "[TaxRate](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#taxrate)", "properties": { "cessRate": { "type": "integer" }, "gstRate": { "type": "integer" }, "taxType": { "enum": [ "CGST", "SGST", "IGST", "TOTAL_TAX" ], "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "spapi.TransportationOption": { "$ref": "#/components/schemas/TransportationOption" }, "spapi.Weight": { "$ref": "#/components/schemas/Weight" }, "spapi.availabilityType": { "$ref": "#/components/schemas/availabilityType" }, "spapi.shippingMode": { "$ref": "#/components/schemas/shippingMode" }, "v1.batch": { "$ref": "#/components/schemas/batch" }, "v1.buylist": { "$ref": "#/components/schemas/buylist" }, "v1.inventory": { "$ref": "#/components/schemas/inventory" }, "v2.box": { "$ref": "#/components/schemas/box" }, "v2.box_input": { "$ref": "#/components/schemas/box_input" }, "v2.box_item": { "$ref": "#/components/schemas/box_item" }, "v2.box_item_input": { "$ref": "#/components/schemas/box_item_input" }, "v2.delivery_window_option": { "properties": { "availability_type": { "$ref": "#/components/schemas/availabilityType" }, "delivery_window_option_id": { "type": "string" }, "end_date": { "type": "string" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "valid_until": { "type": "string" } }, "type": "object" }, "v2.delivery_window_option_input": { "properties": { "availability_type": { "$ref": "#/components/schemas/availabilityType" }, "end_date": { "type": "string" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "valid_until": { "type": "string" } }, "type": "object" }, "v2.inbound_plan": { "$ref": "#/components/schemas/inbound_plan" }, "v2.inbound_plan_input": { "$ref": "#/components/schemas/inbound_plan_input" }, "v2.inventory": { "$ref": "#/components/schemas/inventory2" }, "v2.packing_option": { "$ref": "#/components/schemas/packing_option" }, "v2.pallet": { "$ref": "#/components/schemas/pallet" }, "v2.pallet_input": { "$ref": "#/components/schemas/pallet_input" }, "v2.placement_option": { "$ref": "#/components/schemas/placement_option" }, "v2.product": { "$ref": "#/components/schemas/product2" }, "v2.shipment": { "$ref": "#/components/schemas/shipment" }, "v2.shipment_input": { "$ref": "#/components/schemas/shipment_input" }, "v2.transportation_option": { "$ref": "#/components/schemas/transportation_option" }, "v2.transportation_option_input": { "$ref": "#/components/schemas/transportation_option_input" }, "webhook": { "type": "object", "properties": { "web_hook_id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "endpoint": { "type": "string" }, "secret_key": { "type": "string" }, "enabled": { "type": "boolean" }, "options": { "type": "object", "additionalProperties": { "type": "string" } } } }, "wm.Error": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "description": { "type": "string" }, "info": { "type": "string" }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ] }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ] }, "causes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" } } } } } }, "wm.Address": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateCode": { "type": "string" }, "countryCode": { "type": "string" }, "postalCode": { "type": "string" }, "phone": { "type": "string" } }, "required": [] }, "wm.Address2": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateOrProvince": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" } }, "required": [] }, "wm.ParcelShipmentPackage": { "type": "object", "required": [ "packageSequenceNumber", "weight", "weightUOM", "length", "width", "height", "lengthUOM", "packageType" ], "properties": { "packageSequenceNumber": { "type": "integer" }, "weight": { "type": "number" }, "weightUOM": { "type": "string", "enum": [ "LB" ] }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "lengthUOM": { "type": "string", "enum": [ "IN" ] }, "packageType": { "type": "string", "enum": [ "SINGLE SKUS", "MIXED SKUS" ] } } }, "wm.LtlShipmentPackage": { "type": "object", "required": [ "packageSequenceNumber", "weight", "weightUOM", "length", "width", "height", "lengthUOM", "packageType" ], "properties": { "packageSequenceNumber": { "type": "integer" }, "weight": { "type": "number" }, "weightUOM": { "type": "string", "enum": [ "LB" ] }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "lengthUOM": { "type": "string", "enum": [ "IN" ] }, "packageType": { "type": "string", "enum": [ "PALLET" ] } } }, "wm.Mode": { "type": "string", "enum": [ "PARCEL", "LTL" ] }, "wm_shipment": { "type": "object", "properties": { "wm_shipment_id": { "type": "string" }, "user_id": { "type": "string", "format": "uuid" }, "batch_id": { "format": "int64", "type": "integer" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string", "format": "uuid" }, "updated": { "type": "string", "format": "date-time" }, "updated_by": { "type": "string", "format": "uuid" }, "archived": { "type": "string", "format": "date-time" }, "archived_by": { "type": "string", "format": "uuid" }, "marketplace_name": { "type": "string" }, "source_address": { "type": "integer" }, "status": { "type": "string", "default": "PENDING_SHIPMENT_DETAILS" }, "ship_to_address": { "$ref": "#/components/schemas/wm.Address" }, "shipment_items": { "type": "array", "items": { "type": "object" } }, "shipment_units": { "type": "integer" }, "received_units": { "type": "integer" }, "items_submitted": { "type": "integer" }, "received_units_at_fc": { "type": "integer" }, "expected_delivery_date": { "type": "string", "format": "date-time" }, "updated_expected_delivery_date": { "type": "string", "format": "date-time" }, "actual_delivery_date": { "type": "string", "format": "date-time" }, "tracking_no": { "type": "array", "items": { "type": "string" } }, "carrier_name": { "type": "string" }, "channel_method": { "type": "string" }, "ship_node": { "type": "string" }, "shipment_status": { "type": "string" }, "shipment_type": { "type": "string" }, "po_type": { "type": "string" }, "shipment_carrier_type": { "type": "string" }, "is_exception_occurred": { "type": "boolean" }, "exception_status": { "type": "string" }, "is_po_box_enabled": { "type": "boolean" }, "transfer_shipments": { "type": "object" }, "consolidated_transfer_shipments": { "type": "object" }, "receipt_start_date": { "type": "string", "format": "date-time" }, "receipt_end_date": { "type": "string", "format": "date-time" }, "data": { "type": "object" }, "carrier_rate_quotes": { "type": "object" }, "inbound_order_id": { "type": "string" }, "preferred_pickup_date": { "type": "string", "format": "date-time" }, "freight_class": { "type": "number" }, "declared_value": { "type": "number" }, "pickup_instructions": { "type": "string" } } }, "wm_box": { "type": "object", "properties": { "wm_box_id": { "format": "int64", "type": "integer" }, "wm_shipment_id": { "type": "string" }, "user_id": { "type": "string", "format": "uuid" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string", "format": "uuid" }, "updated": { "type": "string", "format": "date-time" }, "updated_by": { "type": "string", "format": "uuid" }, "package_sequence_number": { "type": "integer" }, "length": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "length_uom": { "type": "string", "enum": [ "IN" ], "default": "IN" }, "weight": { "type": "number" }, "weight_uom": { "type": "string", "enum": [ "LB" ], "default": "LB" }, "label_information": { "type": "object" }, "billing_weight": { "type": "number" }, "net_charge": { "type": "number" }, "nominal_charge": { "type": "number" }, "assessorial_charge": { "type": "number" }, "service_charge": { "type": "number" }, "package_type": { "type": "string" }, "no_of_packages": { "type": "integer", "default": 1 }, "stackable": { "type": "boolean", "default": true }, "mixed_skus": { "type": "boolean", "default": false } } }, "wm_pallet": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "created_by": { "type": "string", "format": "uuid" }, "deleted": { "type": "string", "format": "date-time" }, "height": { "type": "number" }, "length": { "type": "number" }, "length_uom": { "type": "string", "enum": [ "IN" ], "default": "IN" }, "no_of_packages": { "type": "integer", "default": 1 }, "package_sequence_number": { "type": "integer" }, "stackable": { "type": "boolean", "default": false }, "updated": { "type": "string", "format": "date-time" }, "updated_by": { "type": "string", "format": "uuid" }, "via_api": { "type": "boolean", "default": false }, "weight": { "type": "number" }, "weight_uom": { "type": "string", "enum": [ "LB" ], "default": "LB" }, "width": { "type": "number" }, "wm_pallet_id": { "format": "int64", "type": "integer" }, "wm_shipment_id": { "type": "string" } } }, "wm.OrderItem": { "type": "object", "required": [ "productId", "productType", "sku", "itemDesc", "itemQty", "vendorPackQty", "innerPackQty", "expectedDeliveryDate" ], "properties": { "productId": { "type": "string" }, "productType": { "type": "string" }, "sku": { "type": "string" }, "itemDesc": { "type": "string" }, "itemQty": { "type": "integer" }, "vendorPackQty": { "type": "integer" }, "innerPackQty": { "type": "integer" }, "expectedDeliveryDate": { "type": "string", "format": "date-time" }, "addOnServices": { "type": "array", "items": { "type": "object", "properties": { "serviceType": { "type": "string" } } } }, "itemNbr": { "type": "integer" }, "dimensions": { "type": "array", "items": { "type": "number" } }, "itemWeightQty": { "type": "number" }, "nonSortItem": { "type": "boolean" }, "shipNode": { "type": "string" } } }, "PrepMatrix": { "type": "object", "properties": { "prep_matrix_id": { "format": "int64", "type": "integer", "description": "Unique ID for the prep_matrix_name" }, "prep_matrix_name": { "type": "string", "description": "What preparations need to be made, eg 'Bubblewrap', 'Security + Label', etc." }, "prep_matrix_category_id": { "type": "integer", "format": "int64", "description": "The prep matrix category id" }, "prep_matrix_category_name": { "type": "string", "description": "The prep matrix category name" }, "created": { "type": "string", "format": "date-time", "description": "Timestamp when the prep_matrix was created" }, "updated": { "type": "string", "format": "date-time", "description": "Timestamp when the prep_matrix was last updated" }, "ad_hoc": { "type": "boolean", "description": "Charges that are not tier-based, eg. custom per shipment charges." }, "price": { "type": "integer", "description": "The price, in the smallest currency unit, per unit to charge for ad-hoc prep. For example $5.00 will be `500`. Non-ad-hoc preps will have the price set at the tier level." }, "currency_code": { "type": "string", "description": "The currency that the ad-hoc price will be charged in. Eg. USD, EUR, etc." }, "client_id": { "type": "string", "format": "uuid", "description": "An optional client user id for prep types that are specific to the given client" } }, "required": [ "prep_matrix_id", "prep_matrix_name", "created" ] }, "NewPrepMatrix": { "type": "object", "properties": { "prep_matrix_name": { "type": "string", "description": "What preparations need to be made, eg 'Bubblewrap', 'Security + Label', etc." }, "ad_hoc": { "type": "boolean", "description": "Charges that are not tier-based, eg. custom per shipment charges." }, "price": { "type": "integer", "description": "The price, in the smallest currency unit, per unit to charge for prep. For example $5.00 will be `500`" }, "currency_code": { "type": "string", "description": "The currency that the price will be charged in. Eg. USD, EUR, etc." }, "client_id": { "type": "string", "format": "uuid", "description": "An optional client user id for prep types that are specific to the given client" } }, "required": [ "prep_matrix_name" ] }, "NewPrepMatrixProduct": { "type": "object", "description": "An object specifying a new prep_matrix_product to be inserted. Note that in addition to `external_id`, either `prep_matrix_id` or `prep_matrix_name` is also required.", "properties": { "external_id": { "type": "string", "description": "ASIN for Amazon items, itemId for Walmart items" }, "prep_matrix_id": { "format": "int64", "type": "integer", "description": "Unique ID for the prep_matrix_name" }, "prep_matrix_name": { "type": "string", "description": "What preparations need to be made, eg 'Bubblewrap', 'Security + Label', etc." } }, "required": [ "external_id" ] }, "PrepMatrixProduct": { "type": "object", "properties": { "external_id": { "type": "string", "description": "ASIN for Amazon items, itemId for Walmart items" }, "prep_matrix_id": { "format": "int64", "type": "integer", "description": "Unique ID for the prep_matrix_name" }, "created": { "type": "string", "format": "date-time", "description": "Timestamp when the prep_matrix_product was created" }, "updated": { "type": "string", "format": "date-time", "description": "Timestamp when the prep_matrix_product was last updated" } }, "required": [ "external_id", "prep_matrix_id", "created" ] }, "PrepBillingReportResponse": { "type": "array", "items": { "type": "object", "properties": { "user_id": { "type": "string", "format": "uuid", "description": "The id of the prep client" }, "user_name": { "type": "string", "description": "Either the business name or the user name of the prep client" }, "prep_tier_name": { "type": "string", "description": "The name of the tier the prep client is on" }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" }, "prep_tier_type": { "type": "string", "enum": [ "unit", "weight" ] }, "batches": { "type": "array", "items": { "type": "object", "properties": { "batch_id": { "type": "integer" }, "name": { "type": "string", "description": "The name of the batch" }, "created": { "type": "string", "format": "date-time" }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string" }, "msku": { "type": "string" }, "price": { "type": "integer", "description": "The price, in the smallest currency unit. For example $5.00 will be `500`" }, "title": { "type": "string" }, "quantity": { "type": "integer" }, "total_price": { "type": "integer", "description": "The price × quantity, in the smallest currency unit. For example $5.00 will be `500`" }, "currency_code": { "type": "string" }, "prep_matrix_name": { "type": "string" }, "prep_matrix_category_id": { "type": "integer", "format": "int64" }, "prep_matrix_category_name": { "type": "string" } } } }, "shipments": { "type": "array", "items": { "type": "object", "properties": { "shipment_confirmation_id": { "type": "string" }, "update_shipment_tracking_details_operation_at": { "type": "string", "format": "date-time", "description": "Technically when tracking details were submitted to Amazon, used to determine when the batch was finished." }, "charges": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "integer", "description": "The price, in the smallest currency unit. For example $5.00 will be `500`" }, "quantity": { "type": "integer" }, "total_price": { "type": "integer", "description": "The price × quantity, in the smallest currency unit. For example $5.00 will be `500`" }, "currency_code": { "type": "string" }, "prep_matrix_name": { "type": "string" } } } } } } } } } } } } }, "AdHocPrepMatrixResponse": { "type": "object", "properties": { "total_rows": { "type": "integer", "format": "int64" }, "ad_hoc_prep_matrices": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": "integer", "description": "The price, in the smallest currency unit. For example $5.00 will be `500`" }, "quantity": { "type": "integer" }, "client_id": { "type": "string", "format": "uuid" }, "batch_id": { "type": "string", "description": "The Amazon batch id" }, "v2_batch_id": { "type": "string", "description": "The Walmart batch id" }, "shipment_id": { "type": "string", "description": "The Amazon shipment id, which is distinct from the shipment_confirmation_id" }, "wm_shipment_id": { "type": "string", "description": "The Walmart shipment id" }, "purchase_order_id": { "type": "string" }, "currency_code": { "type": "string" }, "prep_matrix_id": { "type": "integer", "format": "int64" }, "prep_matrix_name": { "type": "string" } } } } } }, "PrepMatrixCategory": { "type": "object", "properties": { "prep_matrix_category_id": { "type": "integer", "format": "int64", "description": "The prep matrix category id" }, "prep_matrix_category_name": { "type": "string", "description": "The prep matrix category name" } } }, "PrepTier": { "type": "object", "properties": { "prep_tier_id": { "type": "integer", "format": "int64" }, "prep_tier_name": { "type": "string" }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" }, "prep_tier_type": { "type": "string", "enum": [ "unit", "weight" ] }, "bill_for_packed_boxes": { "type": "boolean", "description": "When true, automatically creates ad-hoc prep matrix charges for each box size when packing is confirmed in Prep & Ship. Matches box template names to prep matrices in the 'Packing' category." } }, "required": [ "prep_tier_id", "prep_tier_name" ] }, "NewPrepTier": { "type": "object", "properties": { "prep_tier_name": { "type": "string" }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" }, "prep_tier_type": { "type": "string", "enum": [ "unit", "weight" ] }, "prep_matrix_tiers": { "type": "array", "description": "An array of prep matrices and prices to map to this tier", "items": { "type": "object", "properties": { "price": { "type": "integer", "description": "The price, in the smallest currency unit. For example $5.00 will be `500`" }, "currency_code": { "type": "string" }, "prep_matrix_id": { "type": "integer", "format": "int64", "description": "Either this or prep_matrix_name are required" }, "prep_matrix_name": { "type": "string", "description": "Either this or prep_matrix_id are required" } }, "required": [ "price", "currency_code" ] } }, "client_ids": { "type": "array", "description": "An array of client ids to assign to this tier", "items": { "type": "string" } } }, "required": [ "prep_tier_name" ] }, "NewPrepMatrixTier": { "type": "object", "properties": { "prep_matrix_name": { "type": "string", "description": "What preparations need to be made, eg 'Bubblewrap', 'Security + Label', etc." }, "prep_tier_id": { "type": "integer", "format": "int64", "description": "The prep matrix category id" }, "price": { "type": "integer", "description": "The price, in the smallest currency unit, per unit to prep. For example $5.00 will be `500`." }, "currency_code": { "type": "string", "description": "The currency that charge is in. Eg. USD, EUR, etc." } }, "required": [ "prep_matrix_name", "prep_tier_id", "price", "currency_code" ] }, "PrepMatrixTier": { "allOf": [ { "type": "object", "properties": { "prep_matrix_id": { "format": "int64", "type": "integer", "description": "Unique ID for the prep_matrix_name" } }, "required": [ "prep_matrix_id" ] }, { "$ref": "#/components/schemas/NewPrepMatrixTier" } ] }, "UpdatePrepMatrixTier": { "type": "object", "properties": { "prep_matrix_id": { "format": "int64", "type": "integer", "description": "Unique ID for the prep_matrix_name" }, "prep_tier_id": { "type": "integer", "format": "int64", "description": "The prep matrix category id" }, "price": { "type": "integer", "description": "The price, in the smallest currency unit, per unit to prep. For example $5.00 will be `500`." }, "currency_code": { "type": "string", "description": "The currency that charge is in. Eg. USD, EUR, etc." }, "deleted": { "type": "boolean" } }, "required": [ "prep_matrix_id", "prep_tier_id" ] }, "PrepClientTier": { "type": "object", "properties": { "prep_tier_id": { "type": "integer", "format": "int64", "description": "The prep matrix category id" }, "client_id": { "type": "string", "format": "uuid" } }, "required": [ "prep_tier_id", "client_id" ] }, "Address": { "type": "object", "description": "[Address](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#address)", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "companyName": { "type": "string" }, "countryCode": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "phoneNumber": { "type": "string" }, "postalCode": { "type": "string" }, "stateOrProvinceCode": { "type": "string" } } }, "Pagination": { "type": "object", "description": "[Pagination](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#pagination)", "properties": { "nextToken": { "type": "string" } } }, "PrepOwner": { "type": "string", "description": "[PrepOwner](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#prepowner)", "enum": [ "AMAZON", "SELLER", "NONE" ] }, "ItemInput": { "type": "object", "description": "[ItemInput](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#iteminput)", "properties": { "expiration": { "type": "string" }, "labelOwner": { "type": "string", "description": "[LabelOwner](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#labelowner)", "enum": [ "AMAZON", "SELLER", "NONE" ] }, "manufacturingLotCode": { "type": "string" }, "msku": { "type": "string" }, "prepOwner": { "$ref": "#/components/schemas/PrepOwner" }, "quantity": { "type": "integer" } } }, "BoxContentInformationSource": { "type": "string", "description": "[BoxContentInformationSource](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#boxcontentinformationsource)", "enum": [ "BOX_CONTENT_PROVIDED", "MANUAL_PROCESS", "BARCODE_2D" ] }, "Region": { "type": "object", "description": "[Region](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#region)", "properties": { "countryCode": { "type": "string" }, "state": { "type": "string" }, "warehouseId": { "type": "string" } } }, "Dimensions": { "type": "object", "description": "[Dimensions](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#dimensions)", "properties": { "height": { "type": "integer" }, "length": { "type": "integer" }, "width": { "type": "integer" }, "unitOfMeasurement ": { "type": "string", "description": "[UnitOfMeasurement](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#unitofmeasurement)", "enum": [ "IN", "CM" ] } } }, "Currency": { "type": "object", "description": "[Currency](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#currency)", "properties": { "amount": { "type": "integer" }, "code": { "type": "string" } } }, "PrepInstruction": { "type": "object", "description": "[PrepInstruction](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#prepinstruction)", "properties": { "fee": { "$ref": "#/components/schemas/Currency" }, "prepOwner": { "$ref": "#/components/schemas/PrepOwner" }, "prepType": { "type": "string", "enum": [ "ITEM_LABELING", "ITEM_BUBBLEWRAP", "ITEM_POLYBAGGING", "ITEM_TAPING", "ITEM_BLACK_SHRINKWRAP", "ITEM_HANG_GARMENT", "ITEM_BOXING", "ITEM_SETCREAT", "ITEM_RMOVHANG", "ITEM_SUFFOSTK", "ITEM_CAP_SEALING", "ITEM_DEBUNDLE", "ITEM_SETSTK", "ITEM_SIOC", "ITEM_NO_PREP", "ADULT", "BABY", "TEXTILE", "HANGER", "FRAGILE", "LIQUID", "SHARP", "SMALL", "PERFORATED", "GRANULAR", "SET", "FC_PROVIDED", "UNKNOWN", "NONE" ] } } }, "Item": { "type": "object", "description": "[Item](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#item)", "properties": { "asin": { "type": "string" }, "expiration": { "type": "string" }, "fnsku": { "type": "string" }, "labelOwner": { "type": "string" }, "manufacturingLotCode": { "type": "string" }, "msku": { "type": "string" }, "prepInstructions": { "type": "array", "items": { "$ref": "#/components/schemas/PrepInstruction" } }, "quantity": { "type": "integer" } } }, "Weight": { "type": "object", "description": "[Weight](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#weight)", "properties": { "unit": { "type": "string", "description": "[UnitOfWeight](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#unitofweight)", "enum": [ "LB", "KG" ] }, "value": { "type": "integer" } } }, "Box": { "type": "object", "description": "[Box](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#box)", "properties": { "boxId": { "type": "string" }, "contentInformationSource": { "$ref": "#/components/schemas/BoxContentInformationSource" }, "destinationRegion": { "$ref": "#/components/schemas/Region" }, "dimensions": { "$ref": "#/components/schemas/Dimensions" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } }, "packageId": { "type": "string" }, "quantity": { "type": "integer" }, "templateName": { "type": "string" }, "weight": { "$ref": "#/components/schemas/Weight" } } }, "InboundOperationStatus": { "description": "[InboundOperationStatus](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#inboundoperationstatus)", "properties": { "operation": { "type": "string" }, "operationId": { "type": "string" }, "operationProblems": { "items": { "description": "[OperationProblem](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#operationproblem)", "properties": { "code": { "type": "string" }, "details": { "type": "string" }, "message": { "type": "string" }, "severity": { "type": "string" } }, "type": "object" }, "type": "array" }, "operationStatus": { "description": "[OperationStatus](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#operationstatus)", "enum": [ "SUCCESS", "FAILED", "IN_PROGRESS" ], "type": "string" } }, "type": "object" }, "BoxInput": { "type": "object", "description": "[BoxInput](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#boxinput)", "properties": { "contentInformationSource": { "$ref": "#/components/schemas/BoxContentInformationSource" }, "dimensions": { "$ref": "#/components/schemas/Dimensions" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ItemInput" } }, "quantity": { "type": "integer" }, "weight": { "$ref": "#/components/schemas/Weight" } } }, "shippingMode": { "type": "string", "enum": [ "GROUND_SMALL_PARCEL", "FREIGHT_LTL", "FREIGHT_FTL_PALLET", "FREIGHT_FTL_NONPALLET", "OCEAN_LCL", "OCEAN_FCL", "AIR_SMALL_PARCEL", "AIR_SMALL_PARCEL_EXPRESS" ] }, "Stackability": { "type": "string", "description": "[Stackability](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#stackability)", "enum": [ "STACKABLE", "NON_STACKABLE" ] }, "ContactInformation": { "type": "object", "description": "[ContactInformation](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#contactinformation)", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" } } }, "Dates": { "type": "object", "description": "[Dates](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#date)", "properties": { "readyToShipWindow": { "type": "object", "description": "[Window](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#window)", "properties": { "editableUntil": { "type": "string" }, "start": { "type": "string" }, "end": { "type": "string" } } } } }, "ShipmentDestination": { "type": "object", "description": "[ShipmentDestination](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#shipmentdestination)", "properties": { "address": { "$ref": "#/components/schemas/Address" }, "destinationType": { "type": "string", "enum": [ "AMAZON_OPTIMIZED", "AMAZON_WAREHOUSE" ] }, "warehouseId": { "type": "string" } } }, "FreightInformation": { "type": "object", "description": "[FreightInformation](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#freightinformation)", "properties": { "declaredValue": { "type": "object", "description": "[Currency](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#currency)", "properties": { "amount": { "type": "integer" }, "code": { "type": "string" } } }, "freightClass": { "type": "string", "enum": [ "NONE", "FC_50", "FC_55", "FC_60", "FC_65", "FC_70", "FC_77_5", "FC_85", "FC_92_5", "FC_100", "FC_110", "FC_125", "FC_150", "FC_175", "FC_200", "FC_250", "FC_300", "FC_400", "FC_500" ] } } }, "availabilityType": { "type": "string", "enum": [ "AVAILABLE", "CONGESTED" ] }, "SelectedDeliveryWindow": { "type": "object", "description": "[SelectedDeliveryWindow](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#selecteddeliverywindow)", "properties": { "availabilityType": { "$ref": "#/components/schemas/availabilityType" }, "deliveryWindowOptionId": { "type": "string" }, "editableUntil": { "type": "string" }, "endDate": { "type": "string" }, "startDate": { "type": "string" } } }, "SelfShipAppointmentDetails": { "type": "object", "description": "[SelfShipAppointmentDetails](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#selfshipappointmentdetails)", "properties": { "appointmentId": { "type": "integer" }, "appointmentSlotTime": { "type": "object", "description": "[AppointmentSlotTime](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#appointmentslottime)", "properties": { "endTime ": { "type": "string" }, "startTime ": { "type": "string" } } }, "appointmentStatus": { "type": "string" } } }, "TrackingDetails": { "type": "object", "description": "[TrackingDetails](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#trackingdetails)", "properties": { "ltlTrackingDetail": { "type": "object", "description": "[LtlTrackingDetail](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#ltltrackingdetail)", "properties": { "billOfLadingNumber": { "type": "string" }, "freightBillNumber": { "type": "array", "items": { "type": "string" } } } }, "spdTrackingDetail": { "type": "object", "description": "[SpdTrackingDetail](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#spdtrackingdetail)", "properties": { "spdTrackingItems": { "type": "array", "items": { "type": "object", "description": "[SpdTrackingItem](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#spdtrackingitem)", "properties": { "boxId": { "type": "string" }, "trackingId": { "type": "string" }, "trackingNumberValidationStatus": { "type": "string", "enum": [ "VALIDATED", "NOT_VALIDATED" ] } } } } } } } }, "Shipment": { "type": "object", "description": "[Shipment](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#shipment)", "required": [ "shipmentId" ], "properties": { "amazonReferenceId": { "type": "string" }, "contactInformation": { "$ref": "#/components/schemas/ContactInformation" }, "dates": { "$ref": "#/components/schemas/Dates" }, "destination ": { "$ref": "#/components/schemas/ShipmentDestination" }, "freightInformation": { "$ref": "#/components/schemas/FreightInformation" }, "name": { "type": "string" }, "placementOptionId": { "type": "string" }, "selectedDeliveryWindow": { "$ref": "#/components/schemas/SelectedDeliveryWindow" }, "selectedTransportationOptionId ": { "type": "string" }, "selfShipAppointmentDetails ": { "type": "array", "items": { "$ref": "#/components/schemas/SelfShipAppointmentDetails" } }, "shipmentConfirmationId": { "type": "string" }, "shipmentId": { "type": "string" }, "source": { "type": "object", "description": "[ShipmentSource](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#shipmentsource)", "properties": { "address": { "$ref": "#/components/schemas/Address" }, "sourceType": { "type": "string", "enum": [ "SELLER_FACILITY" ] } } }, "status": { "type": "string", "enum": [ "ABANDONED", "CANCELLED", "CHECKED_IN", "CLOSED", "DELETED", "DELIVERED", "IN_TRANSIT", "MIXED", "READY_TO_SHIP", "RECEIVING", "SHIPPED", "WORKING" ] }, "trackingDetails": { "$ref": "#/components/schemas/TrackingDetails" } } }, "BoxUpdateInput": { "type": "object", "description": "[BoxUpdateInput](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#boxupdateinput)", "properties": { "contentInformationSource": { "$ref": "#/components/schemas/BoxContentInformationSource" }, "dimensions": { "$ref": "#/components/schemas/Dimensions" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ItemInput" } }, "packageId": { "type": "string" }, "quantity": { "type": "integer" }, "weight": { "$ref": "#/components/schemas/Weight" } } }, "Carrier": { "type": "object", "description": "[Carrier](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#carrier)", "properties": { "alphaCode": { "type": "string" }, "name": { "type": "string" } } }, "CarrierAppointment": { "type": "object", "description": "[CarrierAppointment](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#carrierappointment)", "properties": { "startTime": { "type": "string" }, "endTime": { "type": "string" } } }, "Quote": { "type": "object", "description": "[Quote](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#quote)", "properties": { "cost": { "$ref": "#/components/schemas/Currency" }, "expiration": { "type": "string" }, "voidableUntil": { "type": "string" } } }, "TransportationOption": { "type": "object", "description": "[TransportationOption](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#transportationoption)", "properties": { "carrier": { "$ref": "#/components/schemas/Carrier" }, "carrierAppointment": { "$ref": "#/components/schemas/CarrierAppointment" }, "preconditions": { "type": "array", "items": { "type": "string" } }, "quote": { "$ref": "#/components/schemas/Quote" }, "shipmentId": { "type": "string" }, "shippingMode": { "$ref": "#/components/schemas/shippingMode" }, "shippingSolution": { "type": "string" }, "transportationOptionId": { "type": "string" } } }, "packing_group": { "type": "object", "properties": { "packing_group_id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "asin": { "type": "string" }, "msku": { "type": "string" }, "fnsku": { "type": "string" }, "quantity": { "type": "integer" }, "labelOwner": { "type": "string" }, "prepInstructions": { "type": "array", "items": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "code": { "type": "string" }, "amount": { "type": "integer" } } }, "prepType": { "type": "string" }, "prepOwner": { "type": "string" } } } } } } } } }, "packing_option": { "type": "object", "properties": { "packing_option_id": { "type": "string" }, "fees": { "type": "object" }, "status": { "type": "string" }, "discounts": { "type": "object" }, "expiration": { "type": "string" }, "packing_groups": { "type": "array", "items": { "$ref": "#/components/schemas/packing_group" } } } }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "string" }, "severity": { "type": "string" } } }, "inbound_plan": { "type": "object", "properties": { "inbound_plan_id": { "type": "string" }, "v1_batch_id": { "type": "integer" }, "v2_batch_id": { "type": "integer", "format": "int64" }, "created_at": { "type": "string" }, "last_updated_at": { "type": "string" }, "marketplace_name": { "type": "string" }, "name": { "type": "string" }, "source_address": { "type": "integer" }, "status": { "type": "string" }, "packing_options": { "type": "array", "items": { "$ref": "#/components/schemas/packing_option" } }, "operation_id": { "type": "string" }, "operation_status": { "type": "string" }, "operation_problems": { "type": "array", "items": { "$ref": "#/components/schemas/error" } }, "set_packing_information_operation": { "$ref": "#/components/schemas/InboundOperationStatus" }, "generate_packing_options_operation": { "$ref": "#/components/schemas/InboundOperationStatus" }, "generate_placement_options_operation": { "$ref": "#/components/schemas/InboundOperationStatus" }, "generate_shipment_content_update_previews_operation": { "$ref": "#/components/schemas/InboundOperationStatus" }, "generate_self_ship_appointment_slots_operation": { "$ref": "#/components/schemas/InboundOperationStatus" }, "generate_transportation_options_operation": { "$ref": "#/components/schemas/InboundOperationStatus" } } }, "placement_option": { "type": "object", "properties": { "fees": { "type": "object" }, "status": { "type": "string" }, "discounts": { "type": "object" }, "expiration": { "type": "string" }, "shipments": { "type": "array", "items": { "$ref": "#/components/schemas/Shipment" } } } }, "box_item": { "type": "object", "required": [ "box_id", "sku", "quantity" ], "properties": { "box_id": { "type": "integer", "format": "int64" }, "expiration": { "type": "string" }, "external_id": { "type": "string" }, "fnsku": { "type": "string" }, "label_owner": { "type": "string" }, "manufacturing_lot_code": { "type": "string" }, "prep_instructions": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "integer" }, "code": { "type": "string" } } }, "prepOwner": { "type": "string" }, "prepType": { "type": "string" } } }, "prep_owner": { "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" } } }, "box": { "type": "object", "properties": { "box_id": { "type": "integer", "format": "int64", "description": "The internal id of the box" }, "shipment_id": { "type": "string", "description": "The shipment this box is part of" }, "v1_batch_id": { "type": "integer", "description": "The v1 batch this box is part of" }, "v2_batch_id": { "type": "integer", "format": "int64", "description": "The v2 batch this box is part of" }, "pallet_id": { "type": "integer", "description": "The pallet this box is part of" }, "index": { "type": "integer", "description": "Effectively the box number" }, "quantity": { "type": "integer", "description": "How many copies of this box there are" }, "tracking_id": { "type": "string", "description": "The tracking id" }, "inbound_plan_id": { "type": "string", "description": "The id of the inbound plan this box belongs to" }, "packing_option_id": { "type": "string", "description": "The id of the packing option this box belongs to" }, "packing_group_id": { "type": "string", "description": "The id of the packing group this box belongs to" }, "length": { "type": "integer", "description": "The length of the box in `unit_of_measurement` * 100" }, "width": { "type": "integer", "description": "The width of the box in `unit_of_measurement` * 100" }, "height": { "type": "integer", "description": "The height of the box in `unit_of_measurement` * 100" }, "unit_of_measurement": { "type": "string", "description": "`CM` | `IN`" }, "weight": { "type": "integer", "description": "The weight of the box in `unit_of_weight` * 100" }, "unit_of_weight": { "type": "string", "description": "`KG` | `LB`" } } }, "box_input": { "type": "object", "required": [ "packing_option_id", "inbound_plan_id" ], "properties": { "pallet_id": { "type": "integer", "description": "Move the box to a pallet" }, "quantity": { "type": "integer", "description": "How many copies of this box there are" }, "tracking_id": { "type": "string", "description": "The tracking id" }, "inbound_plan_id": { "type": "string", "description": "The id of the inbound plan this box belongs to" }, "packing_option_id": { "type": "string", "description": "The id of the packing option this box belongs to" }, "packing_group_id": { "type": "string", "description": "The id of the packing group this box belongs to" }, "length": { "type": "integer", "description": "The length of the box in `unit_of_measurement` * 100" }, "width": { "type": "integer", "description": "The width of the box in `unit_of_measurement` * 100" }, "height": { "type": "integer", "description": "The height of the box in `unit_of_measurement` * 100" }, "unit_of_measurement": { "type": "string", "description": "`CM` | `IN`" }, "weight": { "type": "integer", "description": "The weight of the box in `unit_of_weight` * 100" }, "unit_of_weight": { "type": "string", "description": "`KG` | `LB`" } } }, "box_item_input": { "type": "object", "properties": { "expiration": { "type": "string" }, "fnsku": { "type": "string" }, "label_owner": { "type": "string" }, "manufacturing_lot_code": { "type": "string" }, "prep_instructions": { "type": "object", "properties": { "fee": { "type": "object", "properties": { "amount": { "type": "integer" }, "code": { "type": "string" } } }, "prepOwner": { "type": "string" }, "prepType": { "type": "string" } } }, "prep_owner": { "type": "string" }, "quantity": { "type": "integer", "description": "Set quantity to this value" }, "packing_group_id": { "type": "string" }, "add_quantity": { "type": "integer", "description": "If this item already exists in the box, increment the quantity by this amount" } } }, "pallet": { "type": "object", "properties": { "pallet_id": { "type": "integer", "format": "int64", "description": "The internal id of the pallet" }, "shipment_id": { "type": "string", "description": "The shipment this pallet is part of" }, "v1_batch_id": { "type": "integer", "description": "The v1 batch this pallet is part of" }, "v2_batch_id": { "type": "integer", "format": "int64", "description": "The v2 batch this pallet is part of" }, "index": { "type": "integer", "description": "Effectively the pallet number" }, "quantity": { "type": "integer", "description": "How many copies of this pallet there are" }, "stackability": { "$ref": "#/components/schemas/Stackability" }, "inbound_plan_id": { "type": "string", "description": "The id of the inbound plan this pallet belongs to" }, "placement_option_id": { "type": "string", "description": "The id of the placement option this pallet belongs to" }, "length": { "type": "integer", "description": "The length of the pallet in `unit_of_measurement` * 100" }, "width": { "type": "integer", "description": "The width of the pallet in `unit_of_measurement` * 100" }, "height": { "type": "integer", "description": "The height of the pallet in `unit_of_measurement` * 100" }, "unit_of_measurement": { "type": "string", "description": "`CM` | `IN`" }, "weight": { "type": "integer", "description": "The weight of the pallet in `unit_of_weight` * 100" }, "unit_of_weight": { "type": "string", "description": "`KG` | `LB`" } } }, "pallet_input": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "How many copies of this pallet there are" }, "stackability": { "$ref": "#/components/schemas/Stackability" }, "inbound_plan_id": { "type": "string", "description": "The id of the inbound plan this pallet belongs to" }, "placement_option_id": { "type": "string", "description": "The id of the placement option this pallet belongs to" }, "length": { "type": "integer", "description": "The length of the pallet in `unit_of_measurement` * 100" }, "width": { "type": "integer", "description": "The width of the pallet in `unit_of_measurement` * 100" }, "height": { "type": "integer", "description": "The height of the pallet in `unit_of_measurement` * 100" }, "unit_of_measurement": { "type": "string", "description": "`CM` | `IN`" }, "weight": { "type": "integer", "description": "The weight of the pallet in `unit_of_weight` * 100" }, "unit_of_weight": { "type": "string", "description": "`KG` | `LB`" } } }, "tag": { "type": "object", "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "integer", "description": "The decimal representation of a hex color. Eg. #ff0000 = 16711680, #0000ff = 255" }, "url": { "type": "string" } } }, "batch": { "type": "object", "properties": { "_id": { "type": "string" }, "name": { "type": "string" }, "marketplace": { "type": "string" }, "ship_from_id": { "type": "string" }, "ship_from": { "type": "object", "properties": { "zip": { "type": "string" }, "city": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "state": { "type": "string" }, "line_1": { "type": "string" }, "line_2": { "type": "string" }, "country": { "type": "string" } } }, "fba": { "type": "boolean" }, "multipack": { "type": "boolean" }, "created": { "type": "string" }, "archived": { "type": "boolean" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/tag" } }, "total_quantity": { "type": "integer" }, "total_count": { "type": "integer" }, "shipments": { "type": "array", "description": "An array of shipment ids associated with this batch", "items": { "type": "string" } }, "purchase_order_id": { "type": "string", "description": "The internal id of the purchase order used to create this batch, if any" }, "batch_type": { "type": "string" } } }, "product": { "type": "object", "properties": { "_id": { "type": "string" }, "asin": { "type": "string" }, "parent": { "description": "The parent ASIN, if any", "type": "string" }, "title": { "type": "string" }, "image": { "type": "string" }, "misc": { "type": "object", "properties": { "dim": { "type": "object", "properties": { "width": { "type": "integer" }, "height": { "type": "integer" }, "length": { "type": "integer" }, "weight": { "type": "integer" } } }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "varSize": { "type": "string" }, "storageFee": { "type": "object", "properties": { "Amount": { "type": "number" }, "CurrencyCode": { "type": "string" } } }, "classificationRanks": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string" }, "rank": { "type": "integer" }, "title": { "type": "string" }, "classificationId": { "type": "string" } } } } } }, "rank": { "type": "integer" }, "marketplace": { "type": "string" }, "group": { "type": "string" }, "upc": { "type": "array", "items": { "type": "string" } }, "expiration_required": { "type": "boolean" } } }, "inventory": { "type": "object", "properties": { "_id": { "type": "string" }, "active": { "type": "boolean" }, "msku": { "type": "string" }, "fnsku": { "type": "string" }, "quantity": { "type": "integer", "description": "If FBM, this is the quantity from the most recent inventory report" }, "fba": { "type": "boolean", "description": "True = FBA, False = FBM" }, "in_stock": { "type": "integer", "description": "Same as `quantity` if FBM, otherwise uses the `\"InStock\"` quantity from the most recent call to the `getInventorySummaries` API" }, "inbound": { "type": "integer", "description": "The `\"Inbound\"` quantity from the most recent call to the `getInventorySummaries` API" }, "transfer": { "type": "integer", "description": "The `\"Transfer\"` quantity from the most recent call to the `getInventorySummaries` API" }, "marketplace": { "type": "string" }, "misc": { "type": "object" }, "price": { "type": "integer", "description": "The tentative sale price, in cents" }, "payout": { "type": "integer", "description": "The calculated price - fees, in cents" }, "product_id": { "type": "string" }, "product": { "$ref": "#/components/schemas/product" }, "condition_id": { "type": "string" }, "condition": { "type": "string" }, "tax_code_id": { "type": "integer" }, "notes": { "type": "string", "description": "A JSON encoded array of strings" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/tag" } }, "prep_instructions": { "type": "array", "items": { "type": "object", "properties": { "PrepOwner": { "type": "string" }, "PrepInstruction": { "type": "string" } } } }, "prep_details": { "type": "object", "properties": { "msku": { "type": "string" }, "prepCategory": { "type": "string" }, "prepTypes": { "type": "array", "items": { "type": "string" } }, "allOwnersConstraint": { "type": "string" }, "prepOwnerConstraint": { "type": "string" }, "labelOwnerConstraint": { "type": "string" } } }, "storage_type": { "type": "string" }, "listings_issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "severity": { "type": "string" }, "attributeNames": { "type": "array", "items": { "type": "string" } }, "categories": { "type": "array", "items": { "type": "string" } } } } }, "listings_issues_updated": { "type": "string" }, "listings_item": { "type": "object", "properties": { "sku": { "type": "string" }, "attributes": { "type": "object" }, "fulfillmentAvailability": { "type": "array", "items": { "type": "object" } }, "notification": { "type": "object" }, "summaries": { "type": "object" }, "submitted": { "type": "boolean" }, "dimensionsSubmitted": { "type": "boolean" } } }, "update_listings_at": { "type": "string" }, "update_listings_issues": { "type": "array", "items": { "type": "object" } }, "report_id": { "type": "string" } } }, "buylist": { "type": "object", "properties": { "_id": { "type": "string" }, "purchased": { "type": "string", "description": "The purchase date" }, "price": { "type": "integer", "description": "The tentative sale price, in cents" }, "cost": { "type": "integer", "description": "The cost, in cents" }, "condition": { "type": "string" }, "source_id": { "type": "integer" }, "source": { "type": "string" }, "expires": { "type": "string", "description": "The expiration date" }, "quantity": { "type": "integer" }, "misc": { "type": "object", "properties": { "payout": { "type": "integer", "description": "The calculated price - fees, in cents" }, "discount": { "type": "string" }, "discount2": { "type": "integer" }, "labor-cost": { "type": "integer" }, "storageFee": { "type": "integer" }, "variations": { "type": "integer" }, "originalCost": { "type": "integer" }, "tax-percentage": { "type": "integer" }, "stocked-variations": { "type": "integer" }, "inbound-shipping-cost": { "type": "integer" } } }, "created_by": { "type": "string" }, "created_by_name": { "type": "string" }, "created_by_abbr": { "type": "string" }, "msku": { "type": "string" }, "condition_notes": { "type": "string" }, "origin": { "type": "string" }, "inventory_id": { "type": "integer" }, "batch_item_id": { "type": "integer" }, "deleted": { "type": "integer" }, "archived": { "type": "integer" }, "product": { "$ref": "#/components/schemas/product" }, "channel": { "type": "string", "enum": [ "az", "wm" ] }, "wm_item_id": { "type": "string", "description": "If channel is `wm`, this will be the walmart item id" }, "tax_code": { "type": "string" } } }, "batch_item": { "type": "object", "properties": { "_id": { "type": "string" }, "batch_id": { "type": "string" }, "inventory_id": { "type": "string" }, "inventory": { "$ref": "#/components/schemas/inventory" }, "quantity": { "type": "integer" }, "unshipped": { "type": "integer" }, "quantity_in_case": { "type": "integer" }, "damaged": { "type": "integer" }, "purchase_order_batch_items": { "type": "object", "properties": { "_id": { "type": "string" }, "purchase_order_id": { "type": "string" }, "purchase_order_name": { "type": "string" }, "purchase_order_item_id": { "type": "string" }, "quantity": { "type": "integer" } } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/tag" } }, "errors": { "type": "array", "items": { "type": "string" } }, "buylist": { "type": "array", "items": { "$ref": "#/components/schemas/buylist" } }, "misc": { "type": "object" }, "prep_instructions": { "type": "array", "items": { "type": "object", "properties": { "PrepOwner": { "type": "string" }, "PrepInstruction": { "type": "string" } } } }, "prep_owner": { "type": "string" }, "label_owner": { "type": "string" }, "lot_code": { "type": "string" }, "packing_group_id": { "type": "string" }, "updated": { "type": "string", "format": "date-time" } } }, "inventory_input": { "type": "object", "properties": { "_id": { "type": "string" }, "msku": { "type": "string" }, "fnsku": { "type": "string" }, "product": { "type": "object", "properties": { "_id": { "type": "string" }, "asin": { "type": "string" }, "marketplace": { "type": "string" } }, "required": [ "asin" ] }, "condition": { "type": "string" }, "fba": { "type": "boolean" }, "notes": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/tag" } }, "price": { "type": "number" }, "floor": { "type": "number" }, "ceiling": { "type": "number" }, "tax_code_id": { "type": "string" }, "marketplace": { "type": "string" } }, "required": [ "msku", "product" ] }, "buylist_input": { "type": "object", "properties": { "_id": { "type": "string" }, "asin": { "type": "string" }, "condition": { "type": "string" }, "inventory_id": { "type": "string" }, "source_id": { "type": "string" }, "source": { "type": "string" }, "quantity": { "type": "integer" }, "cost": { "type": "integer" }, "price": { "type": "integer" }, "purchased": { "type": "string", "format": "date-time" }, "expires": { "type": "string", "format": "date-time" }, "msku": { "type": "string" }, "notes": { "type": "string" }, "misc": { "type": "object" }, "condition_notes": { "type": "string" } }, "required": [ "asin", "condition", "quantity" ] }, "batch_item_input": { "type": "object", "properties": { "inventory": { "$ref": "#/components/schemas/inventory_input" }, "quantity": { "type": "integer" }, "quantity_in_case": { "type": "integer" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/tag" } }, "buylist": { "type": "array", "items": { "$ref": "#/components/schemas/buylist_input" } }, "misc": { "type": "object" }, "prep_owner": { "type": "string" }, "label_owner": { "type": "string" }, "lot_code": { "type": "string" } }, "required": [ "inventory", "quantity" ] }, "inbound_plan_input": { "type": "object", "properties": { "marketplace_name": { "type": "string" }, "name": { "type": "string" }, "source_address": { "type": "integer" }, "status": { "type": "string" }, "operation_id": { "type": "string" }, "operation_status": { "type": "string" }, "operation_problems": { "type": "array", "items": { "$ref": "#/components/schemas/error" } }, "set_packing_information_operation": { "$ref": "#/components/schemas/InboundOperationStatus" }, "generate_packing_options_operation": { "$ref": "#/components/schemas/InboundOperationStatus" }, "generate_placement_options_operation": { "$ref": "#/components/schemas/InboundOperationStatus" }, "generate_shipment_content_update_previews_operation": { "$ref": "#/components/schemas/InboundOperationStatus" }, "generate_self_ship_appointment_slots_operation": { "$ref": "#/components/schemas/InboundOperationStatus" }, "generate_transportation_options_operation": { "$ref": "#/components/schemas/InboundOperationStatus" } } }, "transportation_option": { "type": "object", "description": "[TransportationOption](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#transportationoption)", "properties": { "carrier": { "$ref": "#/components/schemas/Carrier" }, "carrier_appointment": { "$ref": "#/components/schemas/CarrierAppointment" }, "created": { "type": "string" }, "created_by": { "type": "string" }, "inbound_plan_id": { "type": "string" }, "placement_option_id": { "type": "string" }, "preconditions": { "type": "array", "items": { "type": "string" } }, "quote": { "$ref": "#/components/schemas/Quote" }, "shipment_id": { "type": "string" }, "shipping_mode": { "$ref": "#/components/schemas/shippingMode" }, "shipping_solution": { "type": "string" }, "transportation_option_id": { "type": "string" }, "updated": { "type": "string" }, "updated_by": { "type": "string" } } }, "transportation_option_input": { "oneOf": [ { "$ref": "#/components/schemas/TransportationOption" }, { "type": "object", "properties": { "carrier": { "$ref": "#/components/schemas/Carrier" }, "carrier_appointment": { "$ref": "#/components/schemas/CarrierAppointment" }, "preconditions": { "type": "array", "items": { "type": "string" } }, "quote": { "$ref": "#/components/schemas/Quote" }, "shipment_id": { "type": "string" }, "shipping_mode": { "$ref": "#/components/schemas/shippingMode" }, "shipping_solution": { "type": "string" }, "transportation_option_id": { "type": "string" } } } ] }, "shipment": { "type": "object", "description": "Pretty much the same data as Amazon's [Shipment](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#shipment)", "properties": { "amazon_reference_id": { "type": "string" }, "contact_information": { "$ref": "#/components/schemas/ContactInformation" }, "dates": { "$ref": "#/components/schemas/Dates" }, "destination": { "$ref": "#/components/schemas/ShipmentDestination" }, "freight_information": { "$ref": "#/components/schemas/FreightInformation" }, "inbound_plan_id": { "type": "string" }, "name": { "type": "string" }, "placement_option_id": { "type": "string" }, "selected_delivery_window": { "$ref": "#/components/schemas/SelectedDeliveryWindow" }, "selected_transportation_option_id": { "type": "string" }, "self_ship_appointment_details": { "$ref": "#/components/schemas/SelfShipAppointmentDetails" }, "shipment_confirmation_id": { "type": "string" }, "shipment_id": { "type": "string" }, "shipping_mode": { "$ref": "#/components/schemas/shippingMode" }, "source": { "type": "integer", "description": "Where Amazon returns a detailed [ShipmentSource](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#shipmentsource) object, we use the internal id of our own `source`. This is the same as the `ship_from_id` on the batch that the shipment originates from." }, "status": { "$ref": "#/components/schemas/Shipment" }, "tracking_details": { "$ref": "#/components/schemas/TrackingDetails" } } }, "product2": { "type": "object", "properties": { "channel_id": { "type": "string" }, "marketplace_name": { "type": "string" }, "external_id": { "type": "string", "description": "An Amazon ASIN or Walmart itemId" }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string", "description": "An image URL" } }, "created": { "type": "string", "description": "The date this item was created in ScanPower" }, "updated": { "type": "string", "description": "The date this item was most recently updated in ScanPower" }, "data": { "type": "object" } } }, "inventory2": { "type": "object", "properties": { "channel_id": { "type": "string" }, "marketplace_name": { "type": "string" }, "external_id": { "type": "string", "description": "An Amazon ASIN or Walmart itemId" }, "product": { "$ref": "#/components/schemas/product2" }, "sku": { "type": "string" }, "condition_id": { "type": "integer" }, "condition": { "type": "string" }, "fba": { "type": "boolean", "description": "True if this item is FBA or WFS." }, "price": { "type": "integer", "description": "The price to send a price feed. This may differ from the `synced_price`." }, "synced_price": { "type": "integer", "description": "The price that this item had outside of ScanPower as of the latest inventory sync." }, "min_price": { "type": "integer", "description": "The minimum price. Passed to integrators to set the lower bound on automatic repricing." }, "max_price": { "type": "integer", "description": "The maximum price. Passed to integrators to set the upper bound on automatic repricing." }, "quantity": { "type": "integer" }, "avg_cost_90_days": { "type": "integer", "description": "The average cost this item has over the last 90 days. Updated whenever a cost is entered." }, "last_cost": { "type": "integer", "description": "The most recent cost entered into ScanPower" }, "created": { "type": "string", "description": "The date this item was created in ScanPower" }, "updated": { "type": "string", "description": "The date this item was most recently updated in ScanPower" }, "synced": { "type": "string", "description": "The date this item was most recently synced to ScanPower" }, "listed": { "type": "string", "description": "The date this item was most recently added to a batch or shipment" }, "fees": { "type": "object" } } }, "shipment_input": { "type": "object", "description": "Pretty much the same data as Amazon's [Shipment](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#shipment)", "properties": { "amazon_reference_id": { "type": "string" }, "contact_information": { "$ref": "#/components/schemas/ContactInformation" }, "dates": { "$ref": "#/components/schemas/Dates" }, "destination": { "$ref": "#/components/schemas/ShipmentDestination" }, "freight_information": { "$ref": "#/components/schemas/FreightInformation" }, "name": { "type": "string" }, "placement_option_id": { "type": "string" }, "selected_delivery_window": { "$ref": "#/components/schemas/SelectedDeliveryWindow" }, "selected_transportation_option_id": { "type": "string" }, "self_ship_appointment_details": { "$ref": "#/components/schemas/SelfShipAppointmentDetails" }, "shipment_confirmation_id": { "type": "string" }, "shipping_mode": { "$ref": "#/components/schemas/shippingMode" }, "source": { "type": "integer", "description": "Where Amazon returns a detailed [ShipmentSource](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#shipmentsource) object, we use the internal id of our own `source`. This is the same as the `ship_from_id` on the batch that the shipment originates from." }, "status": { "$ref": "#/components/schemas/Shipment" }, "tracking_details": { "$ref": "#/components/schemas/TrackingDetails" }, "ship_date": { "type": "string", "description": "The earliest date the shipment will be ready to ship" } } } }, "securitySchemes": { "basic_auth": { "scheme": "basic", "type": "http" }, "bearer_auth": { "bearerFormat": "JWT", "scheme": "bearer", "type": "http" } } }, "x-tagGroups": [ { "name": "Auth", "tags": [ "Auth" ] }, { "name": "Account Management", "tags": [ "Account" ] }, { "name": "Amazon", "tags": [ "Amazon Catalog", "FBA Inbound Shipment", "Inventory" ] }, { "name": "Walmart", "tags": [ "WFS Shipment", "Inventory" ] }, { "name": "Printing", "tags": [ "Printing" ] }, { "name": "Prep Center", "tags": [ "FBA Inbound Shipment", "WFS Shipment", "Account", "Prep Billing" ] }, { "name": "Mobile", "tags": [ "Mobile" ] } ] }