API docs by Redocly

ScanPower API (2.0)

Download OpenAPI specification:

ScanPower Support: support@scanpower.com URL: https://www.scanpower.com License: ScanPower API

Public facing APIs for sellers, prep-centers, and integrators.

Auth

getApiToken

All other API calls require the token that this endpoint provides

Authorizations:
basic_auth
header Parameters
X-Proxy
string

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.

Responses

Response samples

Content type
text/plain
eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...

Get an access token from Amazon with which to make SP-API calls.

Get an access token from Amazon with which to make SP-API calls.

Authorizations:
bearer_auth
query Parameters
marketplace
string
Example: marketplace=US

The marketplace to perform operations in.

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 3600
}

Get Walmart AccessToken

Wrapper around Walmart's token API except we'll use your refresh token (or client id and client secret) automatically and provide the correct parameters for you

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0,
  • "refresh_token": "string"
}

Account

Get a list of active users (parent and sub users)

Get a list of active users (parent and sub users)

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of Client Proxy Users

Get a list of client proxy users

Authorizations:
basic_auth
query Parameters
proxy
string
Example: proxy=proxy

The proxy indicator

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Amazon Catalog

Search Catalog Items

Wrapper around Amazon's searchCatalogItems API

Authorizations:
bearer_auth
query Parameters
identifiers
string
Example: identifiers=B001FOQJOG

A comma separated list of identifiers. Note that SKUs with commas need to be searched one at a time.

identifiersType
string
Example: identifiersType=ASIN
marketplaceIds
Array of strings (MarketplaceId)
Example: marketplaceIds=US
includedData
string

A comma separated list of one or more IncludedData, defaults to summaries.

locale
string
keywords
string
brandNames
string
classificationIds
string
pageSize
integer
Example: pageSize=10
pageToken
string
keywordsLocale
string
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{ }

Wrapper around several SP-API calls for loading product, offers, and pricing data.

This is a wrapper around several SP-API calls for loading product, offers, and pricing data.

Authorizations:
bearer_auth
path Parameters
query
required
string
query Parameters
marketplace
string

Specific marketplace of the requested shipments. Defaults to current marketplace set in ScanPower.

pricing
any

Load pricing data

offers
any

Load offers

parent
any

Load parent ASIN data, if any

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

FBA Inbound Shipment

List InboundPlans

Wrapper around Amazon's listInboundPlans API

Authorizations:
bearer_auth
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
status
string
Enum: "ACTIVE" "VOIDED" "SHIPPED"
sortBy
string
Enum: "LAST_UPDATED_TIME" "CREATION_TIME"
sortOrder
string
Enum: "ASC" "DESC"
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "inboundPlans": [
    ],
  • "pagination": {
    }
}

Create Inbound Plan

Wrapper around Amazon's createInboundPlan API

Authorizations:
bearer_auth
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
destinationMarketplaces
Array of strings
Array of objects (ItemInput)
name
string
object (spapi.AddressInput)

Responses

Request samples

Content type
application/json
{
  • "destinationMarketplaces": [
    ],
  • "items": [
    ],
  • "name": "string",
  • "sourceAddress": {
    }
}

Response samples

Content type
application/json
{
  • "inboundPlanId": "string",
  • "operationId": "string"
}

Get Inbound Plan

Wrapper around Amazon's getInboundPlan API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "inboundPlanId": "string",
  • "lastUpdatedAt ": "string",
  • "marketplaceIds": [
    ],
  • "name": "string",
  • "packingOptions": [
    ],
  • "placementOptions": [
    ],
  • "shipments": [
    ],
  • "sourceAddress": {
    },
  • "status": "ACTIVE"
}

List InboundPlan Boxes

Wrapper around Amazon's listInboundPlanBoxes API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "boxes": [
    ],
  • "pagination": {
    }
}

List InboundPlan Items

Wrapper around Amazon's listInboundPlanItems API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Update InboundPlan Name

Wrapper around Amazon's updateInboundPlanName API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List PackingGroup Boxes

Wrapper around Amazon's listPackingGroupBoxes API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
packingGroupId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "boxes": [
    ],
  • "pagination": {
    }
}

List PackingGroup Items

Wrapper around Amazon's listPackingGroupItems API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
packingGroupId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Set Packing Information

Wrapper around Amazon's setPackingInformation API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "packageGroupings": [
    ]
}

Response samples

Content type
application/json
{
  • "operationId": "string"
}

List Packing Options

Wrapper around Amazon's listPackingOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "packingOptions": [
    ],
  • "pagination": {
    }
}

Generate Packing Options

Wrapper around Amazon's generatePackingOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

list
integer
Value: 1
Example: list=1

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.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
Example
{
  • "operationId": "string"
}

Confirm Packing Option

Wrapper around Amazon's confirmPackingOption API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
packingOptionId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operationId": "string"
}

List InboundPlan Pallets

Wrapper around Amazon's listInboundPlanPallets API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "pallets": [
    ]
}

List Placement Options

Wrapper around Amazon's listPlacementOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "placementOptions": [
    ]
}

Generate Placement Options

Wrapper around Amazon's generatePlacementOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

list
integer
Value: 1
Example: list=1

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.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Confirm Placement Option

Wrapper around Amazon's confirmPlacementOption API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
placementOptionId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Get Shipment

Wrapper around Amazon's getShipment API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "amazonReferenceId": "string",
  • "contactInformation": {
    },
  • "dates": {
    },
  • "destination ": {
    },
  • "freightInformation": {
    },
  • "name": "string",
  • "placementOptionId": "string",
  • "selectedDeliveryWindow": {
    },
  • "selectedTransportationOptionId ": "string",
  • "selfShipAppointmentDetails ": [
    ],
  • "shipmentConfirmationId": "string",
  • "shipmentId": "string",
  • "source": {
    },
  • "status": "ABANDONED",
  • "trackingDetails": {
    }
}

List Shipment Boxes

Wrapper around Amazon's listShipmentBoxes API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "boxes": [
    ],
  • "pagination": {
    }
}

List ShipmentContent UpdatePreviews

Wrapper around Amazon's listShipmentContentUpdatePreviews API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "contentUpdatePreviews": [
    ],
  • "pagination": {
    }
}

Generate ShipmentContent UpdatePreviews

Wrapper around Amazon's generateShipmentContentUpdatePreviews API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
Array of objects (BoxUpdateInput)
Array of objects (ItemInput)

Responses

Request samples

Content type
application/json
{
  • "boxes": [
    ],
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Get ShipmentContent UpdatePreview

Wrapper around Amazon's getShipmentContentUpdatePreview API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
contentUpdatePreviewId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "contentUpdatePreviewId": "string",
  • "expiration": "string",
  • "requestedUpdates": {
    },
  • "transportationOption": {
    }
}

Confirm ShipmentContent UpdatePreview

Wrapper around Amazon's confirmShipmentContentUpdatePreview API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
contentUpdatePreviewId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Get DeliveryChallan Document

Wrapper around Amazon's getDeliveryChallanDocument API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "documentDownload ": {
    }
}

List DeliveryWindow Options

Wrapper around Amazon's listDeliveryWindowOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "deliveryWindowOptions": [
    ],
  • "pagination": {
    }
}

Generate DeliveryWindow Options

Wrapper around Amazon's generateDeliveryWindowOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Confirm DeliveryWindow Options

Wrapper around Amazon's confirmDeliveryWindowOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
deliveryWindowOptionId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operationId": "string"
}

List ShipmentItems

Wrapper around Amazon's listShipmentItems API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Update Shipment Name

Wrapper around Amazon's updateShipmentName API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List Shipment Pallets

Wrapper around Amazon's listShipmentPallets API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "pallets": [
    ]
}

Cancel SelfShip Appointment

Wrapper around Amazon's cancelSelfShipAppointment API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
reasonComment
string
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"

Responses

Request samples

Content type
application/json
{
  • "reasonComment": "APPOINTMENT_REQUESTED_BY_MISTAKE"
}

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Get SelfShip Appointment Slots

Wrapper around Amazon's getSelfShipAppointmentSlots API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "selfShipAppointmentSlotsAvailability": {
    }
}

Generate SelfShip Appointment Slots

Wrapper around Amazon's generateSelfShipAppointmentSlots API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
desiredEndDate
string
desiredStartDate
string

Responses

Request samples

Content type
application/json
{
  • "desiredEndDate": "string",
  • "desiredStartDate": "string"
}

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Schedule SelfShip Appointment

Wrapper around Amazon's scheduleSelfShipAppointment API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
slotId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
reasonComment
string
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"

Responses

Request samples

Content type
application/json
{
  • "reasonComment": "APPOINTMENT_REQUESTED_BY_MISTAKE"
}

Response samples

Content type
application/json
{
  • "selfShipAppointmentDetails": {
    }
}

Update ShipmentSource Address

Wrapper around Amazon's updateShipmentSourceAddress API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
One of
object (spapi.AddressInput)

Responses

Request samples

Content type
application/json
{
  • "source_id": 0
}

Response samples

Content type
application/json
Example
{
  • "operationId": "string"
}

Update Shipment TrackingDetails

Wrapper around Amazon's updateShipmentTrackingDetails API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json

Responses

Request samples

Content type
application/json
{
  • "trackingDetails": {
    }
}

Response samples

Content type
application/json
Example
{
  • "operationId": "string"
}

List Transportation Options

Wrapper around Amazon's listTransportationOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
placementOptionId
string
shipmentId
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "transportationOptions": [
    ]
}

Generate Transportation Options

Wrapper around Amazon's generateTransportationOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

list
integer
Value: 1
Example: list=1

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.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
placementOptionId
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "placementOptionId": "string",
  • "shipmentTransportationConfigurations": [
    ]
}

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Confirm Transportation Options

Wrapper around Amazon's confirmTransportationOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "transportationSelections ": [
    ]
}

Response samples

Content type
application/json
{
  • "operationId": "string"
}

List ItemCompliance Details

Wrapper around Amazon's listItemComplianceDetails API

Authorizations:
bearer_auth
query Parameters
mskus
required
Array of strings
marketplaceId
required
string (MarketplaceId)
Example: marketplaceId=ATVPDKIKX0DER
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "complianceDetails": [
    ]
}

Update ItemCompliance Details

Wrapper around Amazon's updateItemComplianceDetails API

Authorizations:
bearer_auth
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
msku
string
object (spapi.TaxDetails)

Responses

Request samples

Content type
application/json
{
  • "msku": "string",
  • "taxDetails": {
    }
}

Response samples

Content type
application/json
Example
{
  • "operationId": "string"
}

Create Marketplace ItemLabels

Wrapper around Amazon's createMarketplaceItemLabels API

Authorizations:
bearer_auth
header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
height
integer
labelType
string
Enum: "STANDARD_FORMAT" "THERMAL_PRINTING"
localeCode
string
marketplaceId
string (MarketplaceId)
Array of objects
pageType
string
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"
width
integer

Responses

Request samples

Content type
application/json
{
  • "height": 0,
  • "labelType": "STANDARD_FORMAT",
  • "localeCode": "string",
  • "marketplaceId": "ATVPDKIKX0DER",
  • "mskuQuantities": [
    ],
  • "pageType": "A4_21",
  • "width": 0
}

Response samples

Content type
application/json
{
  • "documentDownloads": [
    ]
}

List Prep Details

Wrapper around Amazon's listPrepDetails API

Authorizations:
bearer_auth
query Parameters
marketplaceId
required
string (MarketplaceId)
Example: marketplaceId=ATVPDKIKX0DER
mskus
required
Array of strings
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "mskuPrepDetails": [
    ]
}

Set Prep Details

Wrapper around Amazon's setPrepDetails API

Authorizations:
bearer_auth
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
marketplaceId
string (MarketplaceId)
Array of objects

Responses

Request samples

Content type
application/json
{
  • "marketplaceId": "ATVPDKIKX0DER",
  • "mskuPrepDetails": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "operationId": "string"
}

Get InboundOperation Status

Wrapper around Amazon's getInboundOperationStatus API

Authorizations:
bearer_auth
path Parameters
operationId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operation": "string",
  • "operationId": "string",
  • "operationProblems": [
    ],
  • "operationStatus": "SUCCESS"
}

Get BillOfLading

Wrapper around Amazon's getBillOfLading API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "payload": {
    }
}

Get Labels

Wrapper around Amazon's getLabels API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string
query Parameters
PageType
required
string
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"
LabelType
required
string
Enum: "BARCODE_2D" "UNIQUE" "PALLET"
NumberOfPackages
integer
PackageLabelsToPrint
Array of strings
NumberOfPallets
integer
PageSize
integer
PageStartIndex
integer
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "payload": {
    }
}

Get InboundPlans

Load the inbound plans associated with the given batch

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

Responses

Response samples

Content type
application/json
{
  • "inbound_plans": [
    ],
  • "total_rows": 0
}

Create an inbound plan from the items in the provided batch

Create an inbound plan from the items in the provided batch

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "inbound_plan": {
    }
}

Submit Boxes

Send packed box information to Amazon

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "placement_options": [
    ]
}

List boxes for a v1 Amazon batch

List boxes for a v1 Amazon batch

Authorizations:
bearer_auth
query Parameters
v1_batch_id
string

The id of the v1 batch to load boxes for

v2_batch_id
string

The id of the v2 batch to load boxes for

shipment_id
string

The id of the v2 shipment to load boxes for

with
Array of strings
Items Enum: "configuration" "box_items"

Comma separated list of zero or more of configuration or box_items.

Responses

Response samples

Content type
application/json
{
  • "boxes": [
    ],
  • "total_rows": 0
}

Insert a Box

Insert a Box

Authorizations:
bearer_auth
Request Body schema: application/json
shipment_id
string

The shipment to create the box in

v1_batch_id
integer

The v1 batch to create the box in

v2_batch_id
integer <int64>

The v2 batch to create the box in

pallet_id
integer

Move the box to a pallet

quantity
integer

How many copies of this box there are

tracking_id
string

The tracking id

inbound_plan_id
required
string

The id of the inbound plan this box belongs to

packing_option_id
required
string

The id of the packing option this box belongs to

packing_group_id
string

The id of the packing group this box belongs to

length
integer

The length of the box in unit_of_measurement * 100

width
integer

The width of the box in unit_of_measurement * 100

height
integer

The height of the box in unit_of_measurement * 100

unit_of_measurement
string

CM | IN

weight
integer

The weight of the box in unit_of_weight * 100

unit_of_weight
string

KG | LB

Responses

Request samples

Content type
application/json
{
  • "shipment_id": "string",
  • "v1_batch_id": 0,
  • "v2_batch_id": 0,
  • "pallet_id": 0,
  • "quantity": 0,
  • "tracking_id": "string",
  • "inbound_plan_id": "string",
  • "packing_option_id": "string",
  • "packing_group_id": "string",
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "unit_of_measurement": "string",
  • "weight": 0,
  • "unit_of_weight": "string"
}

Response samples

Content type
application/json
{
  • "box": {
    }
}

Delete a Box

Delete a Box

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to delete

Responses

Response samples

Content type
application/json
{
  • "box": {
    }
}

Get a Box

Get a Box

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to get

Responses

Response samples

Content type
application/json
{
  • "box": {
    }
}

Delete Box

Update Box

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to update

Request Body schema: application/json
pallet_id
integer

Move the box to a pallet

quantity
integer

How many copies of this box there are

tracking_id
string

The tracking id

inbound_plan_id
required
string

The id of the inbound plan this box belongs to

packing_option_id
required
string

The id of the packing option this box belongs to

packing_group_id
string

The id of the packing group this box belongs to

length
integer

The length of the box in unit_of_measurement * 100

width
integer

The width of the box in unit_of_measurement * 100

height
integer

The height of the box in unit_of_measurement * 100

unit_of_measurement
string

CM | IN

weight
integer

The weight of the box in unit_of_weight * 100

unit_of_weight
string

KG | LB

Responses

Request samples

Content type
application/json
{
  • "pallet_id": 0,
  • "quantity": 0,
  • "tracking_id": "string",
  • "inbound_plan_id": "string",
  • "packing_option_id": "string",
  • "packing_group_id": "string",
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "unit_of_measurement": "string",
  • "weight": 0,
  • "unit_of_weight": "string"
}

Response samples

Content type
application/json
{
  • "box": {
    }
}

List BoxItems

List BoxItems

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to get

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Responses

Response samples

Content type
application/json
{
  • "box_items": [
    ],
  • "total_rows": 0
}

Insert BoxItem

Insert BoxItem

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to get

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Request Body schema: application/json
sku
required
string
external_id
required
string
expiration
string
fnsku
string
label_owner
string
manufacturing_lot_code
string
object
prep_owner
string
quantity
integer
packing_group_id
string

Responses

Request samples

Content type
application/json
{
  • "sku": "string",
  • "external_id": "string",
  • "expiration": "string",
  • "fnsku": "string",
  • "label_owner": "string",
  • "manufacturing_lot_code": "string",
  • "prep_instructions": {
    },
  • "prep_owner": "string",
  • "quantity": 0,
  • "packing_group_id": "string"
}

Response samples

Content type
application/json
{
  • "box_item": {
    }
}

Delete BoxItem

Delete BoxItem

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box in which the item to delete resides

sku
required
string

The SKU of the box item to delete

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Responses

Response samples

Content type
application/json
{
  • "box_item": {
    }
}

Update BoxItem

Update BoxItem

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box in which the item to update resides

sku
required
string

The SKU of the box item to update

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Request Body schema: application/json
expiration
string
fnsku
string
label_owner
string
manufacturing_lot_code
string
object
prep_owner
string
quantity
integer
packing_group_id
string

Responses

Request samples

Content type
application/json
{
  • "expiration": "string",
  • "fnsku": "string",
  • "label_owner": "string",
  • "manufacturing_lot_code": "string",
  • "prep_instructions": {
    },
  • "prep_owner": "string",
  • "quantity": 0,
  • "packing_group_id": "string"
}

Response samples

Content type
application/json
{
  • "box_item": {
    }
}

List Pallets

List Pallets

Authorizations:
bearer_auth
query Parameters
v1_batch_id
string

The id of the v1 batch to load pallets for

v2_batch_id
string

The id of the v2 batch to load pallets for

shipment_id
string

The id of the v2 shipment to load pallets for

Responses

Response samples

Content type
application/json
{
  • "boxes": [
    ],
  • "total_rows": 0
}

Insert Pallet

Insert Pallet

Authorizations:
bearer_auth
Request Body schema: application/json
shipment_id
string

The shipment to create the pallet in

v1_batch_id
integer

The v1 batch to create the pallet in

v2_batch_id
integer <int64>

The v2 batch to create the pallet in

quantity
integer

How many copies of this pallet there are

stackability
string (Stackability)
Enum: "STACKABLE" "NON_STACKABLE"
inbound_plan_id
string

The id of the inbound plan this pallet belongs to

placement_option_id
string

The id of the placement option this pallet belongs to

length
integer

The length of the pallet in unit_of_measurement * 100

width
integer

The width of the pallet in unit_of_measurement * 100

height
integer

The height of the pallet in unit_of_measurement * 100

unit_of_measurement
string

CM | IN

weight
integer

The weight of the pallet in unit_of_weight * 100

unit_of_weight
string

KG | LB

Responses

Request samples

Content type
application/json
{
  • "shipment_id": "string",
  • "v1_batch_id": 0,
  • "v2_batch_id": 0,
  • "quantity": 0,
  • "stackability": "STACKABLE",
  • "inbound_plan_id": "string",
  • "placement_option_id": "string",
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "unit_of_measurement": "string",
  • "weight": 0,
  • "unit_of_weight": "string"
}

Response samples

Content type
application/json
{
  • "pallet": {
    }
}

Delete Pallet

Delete Pallet

Authorizations:
bearer_auth
path Parameters
pallet_id
required
string

The id of the pallet to delete

Responses

Response samples

Content type
application/json
{
  • "pallet": {
    }
}

List Pallet

List Pallet

Authorizations:
bearer_auth
path Parameters
pallet_id
required
string

The id of the pallet to get

Responses

Response samples

Content type
application/json
{
  • "pallet": {
    }
}

Update Pallet

Update Pallet

Authorizations:
bearer_auth
path Parameters
pallet_id
required
string

The id of the pallet to update

Request Body schema: application/json
quantity
integer

How many copies of this pallet there are

stackability
string (Stackability)
Enum: "STACKABLE" "NON_STACKABLE"
inbound_plan_id
string

The id of the inbound plan this pallet belongs to

placement_option_id
string

The id of the placement option this pallet belongs to

length
integer

The length of the pallet in unit_of_measurement * 100

width
integer

The width of the pallet in unit_of_measurement * 100

height
integer

The height of the pallet in unit_of_measurement * 100

unit_of_measurement
string

CM | IN

weight
integer

The weight of the pallet in unit_of_weight * 100

unit_of_weight
string

KG | LB

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "stackability": "STACKABLE",
  • "inbound_plan_id": "string",
  • "placement_option_id": "string",
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "unit_of_measurement": "string",
  • "weight": 0,
  • "unit_of_weight": "string"
}

Response samples

Content type
application/json
{
  • "pallet": {
    }
}

Get a list of Purchase Orders.

Get a list of Purchase Orders.

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
query PurchaseOrders(
  $marketplace: String,
  $archived: Boolean,
  $deleted: Boolean,
  $search: [String],
  $ship_from: [ID],
  $received: Boolean,
  $can_add_to_batch: Boolean,
  $has_unreceived: Boolean,
  $purchase_order_id: ID,
  $external_id: String,
  $shipment_ids: [ID],
) {
  purchaseOrders(
    marketplace: $marketplace
    archived: $archived
    deleted: $deleted
    search: $search
    ship_from: $ship_from
    received: $received
    can_add_to_batch: $can_add_to_batch
    has_unreceived: $has_unreceived
    purchase_order_id: $purchase_order_id
    external_id: $external_id
    shipment_ids: $shipment_ids,
  ) {
    _id
    external_id
    name
    ship_from_id
    ship_from
    created
    deleted
    archived
    total_count
    total_ordered
    total_received
    total_shipped
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a single purchase order.

Create a single purchase order.

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation CreatePurchaseOrder(
  $ship_from: ID!,
  $marketplace: String!,
  $name: String,
  $external_id: String,
) {
  createPurchaseOrder(
    ship_from: $ship_from
    marketplace: $marketplace
    name: $name
    external_id: $external_id
  ) {
    _id
    external_id
    name
    ship_from_id
    ship_from
    created
    deleted
    archived
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a purchase order. This does not change any of the items in the PO.

Update a purchase order. This does not change any of the items in the PO.

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation UpdatePurchaseOrder(
  $purchase_order_id: ID!,
  $ship_from: ID,
  $name: String,
  $external_id: String,
  $archived: Boolean,
  $deleted: Boolean
) {
  updatePurchaseOrder(
    purchase_order_id: $purchase_order_id
    ship_from: $ship_from
    name: $name
    external_id: $external_id
    archived: $archived
    deleted: $deleted
  ) {
    _id
    external_id
    name
    ship_from_id
    ship_from
    created
    deleted
    archived
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of purchase order items.

Get a list of purchase order items.

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
query PurchaseOrderItems(
  $purchase_order_ids: [ID],
  $search: String,
  $received: Boolean,
  $can_add_to_batch: Boolean,
  $ship_from: [ID]
) {
  purchaseOrderItems(
    purchase_order_ids: $purchase_order_ids
    search: $search
    received: $received
    can_add_to_batch: $can_add_to_batch
    ship_from: $ship_from
  ) {
    _id
    purchase_order_id
    inventory_id
    inventory {
      msku
      condition
      fnsku
      price
      product {
        asin
        title
        image
        misc
        rank
        upc
        group
        marketplace
        expiration_required
        mapping {
          _id
          upc
          name
          products {
            _id
            quantity
            product {
              _id
              asin
            }
          }
        }
      }
    }
    ordered
    received
    in_batch
    damaged
    missing
    notes
    multipack
    created
    updated
    deleted
    cost
    expires
    batch_items {
      _id
      quantity
      shipments {
        id
        cp
        fcid
        prep
        quantity
        status
      }
    }
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Add items to a purchase order.

Add items to a purchase order.

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation CreatePurchaseOrderItems(
  $purchase_order_id: ID!,
  $items: [PurchaseOrderItemInput!]
) {
  createPurchaseOrderItems(
    purchase_order_id: $purchase_order_id,
    items: $items
  ) {
    _id
    purchase_order_id
    inventory_id
    inventory {
      msku
      condition
      fnsku
      price
      product {
        asin
        title
        image
        misc
        rank
        upc
        group
        marketplace
        expiration_required
        mapping {
          _id
          upc
          name
          products {
            _id
            quantity
            product {
              _id
              asin
            }
          }
        }
      }
    }
    ordered
    received
    in_batch
    damaged
    missing
    notes
    multipack
    created
    updated
    deleted
    cost
    expires
    batch_items {
      _id
      quantity
      shipments {
        id
        cp
        fcid
        prep
        quantity
        status
      }
    }
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a single purchase order item.

Update a single purchase order item.

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation UpdatePurchaseOrderItem(
  $purchase_order_item_id: ID!,
  $item: PurchaseOrderItemInput!
) {
  updatePurchaseOrderItem(
    purchase_order_item_id: $purchase_order_item_id
    item: $item
  ) {
    _id
    purchase_order_id
    inventory_id
    inventory {
      msku
      condition
      fnsku
      price
      product {
        asin
        title
        image
        misc
        rank
        upc
        group
        marketplace
        expiration_required
        mapping {
          _id
          upc
          name
          products {
            _id
            quantity
            product {
              _id
              asin
            }
          }
        }
      }
    }
    ordered
    received
    in_batch
    damaged
    missing
    notes
    multipack
    created
    updated
    deleted
    cost
    expires
    batch_items {
      _id
      quantity
      shipments {
        id
        cp
        fcid
        prep
        quantity
        status
      }
    }
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Batches

Get Batches

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
query Batches(
  $marketplace: String
  $archived: Boolean
  $deleted: Boolean
  $search: [String]
  $ship_from: [ID]
  $batch_id: ID
  $purchase_order_id: ID
  $limit: Int
) {
  batches(
    marketplace: $marketplace
    archived: $archived
    deleted: $deleted
    search: $search
    ship_from:$ship_from
    batch_id: $batch_id
    purchase_order_id: $purchase_order_id
   limit: $limit
  ) {
    _id
    name
    marketplace
    ship_from_id
    ship_from
    fba
    multipack
    created
    archived
    deleted
    tags {
      _id
      name
      color
    }
    total_quantity
    total_count
    shipments
    purchase_order_id
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create Batch

Create Batch

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation CreateBatch(
  $ship_from: ID!,
  $marketplace: String!,
  $name: String,
  $tags: [TagInput]
) {
  createBatch(
    ship_from: $ship_from,
    marketplace: $marketplace,
    name: $name,
    tags: $tags
  ) {
    _id
    name
    marketplace
    ship_from_id
    ship_from
    fba
    multipack
    created
    archived
    deleted
    tags {
      _id
      name
      color
    }
    total_quantity
    total_count
    shipments
    purchase_order_id
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Batch

Update Batch

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation 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) {
  updateBatch(
    batch_id: $batch_id
    ship_from: $ship_from
    fba: $fba
    purchase_order_id: $purchase_order_id
    name: $name
    archived: $archived
    deleted: $deleted
    tags: $tags
    prep_type: $prep_type
    current_step: $current_step
    flow: $flow
  ) {
    _id
    name
    marketplace
    ship_from_id
    ship_from
    fba
    created
    archived
    deleted
    tags {
      _id
      name
      color
    }
    total_quantity
    total_count
    shipments
    total_in_shipments
    misc
    batch_type
    carryover_for
    feed_errors
    prep_type
    dirty
    disabled
    purchase_order_id
    current_step
    flow
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get BatchItems

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
query BatchItems($batchId: ID) {
  batchSummary(batch_id: $batchId) {
    batch_id
    total_cost
    total_payout
    avg_rank
    creating_listings
  }
  batchItems(batch_id: $batchId) {
    _id
    batch_id
    inventory_id
    inventory {
      _id
      active
      msku
      fnsku
      quantity
      fba
      in_stock
      inbound
      transfer
      price
      payout
      misc
      product_id
      marketplace
      product {
        _id
        asin
        parent
        title
        image
        misc
        rank
        upc
        group
        marketplace
        expiration_required
        product_type
      }
      condition_id
      condition
      tax_code_id
      notes
      tags { _id name color url icon }
      prep_instructions {PrepOwner PrepInstruction}
      prep_details { prepCategory prepTypes allOwnersConstraint prepOwnerConstraint labelOwnerConstraint }
      storage_type
      listings_issues { code message severity attributeNames categories }
      listings_issues_updated
      listings_item { fulfillmentAvailability submitted attributes dimensionsSubmitted }
      listings_status
      update_listings_at
      update_listings_issues
      report_id
    }
    quantity
    unshipped
    quantity_in_case
    damaged
    deleted
    tags { _id name color }
    errors
    buylist {
      _id
      purchased
      quantity
      cost
      expires
      source
      created_by_name
      misc
      origin
    }
    misc
    prep_instructions { PrepOwner PrepInstruction }
    prep_owner
    label_owner
    lot_code
    packing_group_id
    updated
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

CreateBatchItems

Authorizations:
bearer_auth
query Parameters
op
required
string
Value: "CreateBatchItems"

GraphQL query

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
query
string
mutation CreateBatchItems(
  $batch_id: ID!,
  $items: [BatchItemInput!],
  $marketplace: String!,
  $manuallyCreateFbaListings: Boolean,
) {
  createBatchItems(
    batch_id: $batch_id,
    items: $items,
    marketplace: $marketplace,
    manuallyCreateFbaListings: $manuallyCreateFbaListings,
  ) {
    items {
      _id
      batch_id
      inventory_id
      inventory {
        _id
        active
        msku
        fnsku
        quantity
        fba
        in_stock
        inbound
        transfer
        price
        payout
        misc
        product_id
        marketplace
        product {
          _id
          asin
          parent
          title
          image
          misc
          rank
          upc
          group
          marketplace
          expiration_required
          product_type
        }
        condition_id
        condition
        tax_code_id
        notes
        tags { _id name color url icon }
        prep_instructions {PrepOwner PrepInstruction}
        prep_details { prepCategory prepTypes allOwnersConstraint prepOwnerConstraint labelOwnerConstraint }
        storage_type
        listings_issues { code message severity attributeNames categories }
        listings_issues_updated
        listings_item { fulfillmentAvailability submitted attributes dimensionsSubmitted }
        listings_status
        update_listings_at
        update_listings_issues
        report_id
      }
      quantity
      unshipped
      quantity_in_case
      damaged
      tags { _id name color }
      errors
      buylist {
        _id
        purchased
        quantity
        cost
        expires
        source
        created_by_name
        misc
        origin
      }
      misc
      prep_instructions { PrepOwner PrepInstruction }
      prep_owner
      label_owner
      lot_code
      packing_group_id
      updated
    }
    invalid
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "invalid": [
    ]
}

Update BatchItem

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation UpdateBatchItem(
  $batch_item_id: ID!,
  $add_quantity: Int,
  $set_quantity: Int,
  $quantity_in_case: Int,
  $tags: [TagInput],
  $deleted: Boolean,
  $buylist: [BuylistInput],
  $inventory: InventoryInput,
  $prep_owner: String,
  $label_owner: String,
  $restore_buylist: Boolean,
  $lot_code: String,
) {
  updateBatchItem(
    batch_item_id: $batch_item_id,
    add_quantity: $add_quantity,
    set_quantity: $set_quantity,
    quantity_in_case: $quantity_in_case,
    deleted: $deleted,
    tags: $tags,
    buylist: $buylist,
    inventory: $inventory,
    prep_owner: $prep_owner,
    label_owner: $label_owner,
    restore_buylist: $restore_buylist,
    lot_code: $lot_code,
  ) {
    _id
    batch_id
    inventory_id
    inventory {
      _id
      active
      msku
      fnsku
      quantity
      fba
      in_stock
      inbound
      transfer
      price
      payout
      misc
      product_id
      marketplace
      product {
        _id
        asin
        parent
        title
        image
        misc
        rank
        upc
        group
        marketplace
        expiration_required
        product_type
      }
      condition_id
      condition
      tax_code_id
      notes
      tags { _id name color url icon }
      prep_instructions {PrepOwner PrepInstruction}
      prep_details { prepCategory prepTypes allOwnersConstraint prepOwnerConstraint labelOwnerConstraint }
      storage_type
      listings_issues { code message severity attributeNames categories }
      listings_issues_updated
      listings_item { fulfillmentAvailability submitted attributes dimensionsSubmitted }
      listings_status
      update_listings_at
      update_listings_issues
      report_id
    }
    quantity
    unshipped
    quantity_in_case
    damaged
    tags { _id name color }
    errors
    buylist {
      _id
      purchased
      quantity
      cost
      expires
      source
      created_by_name
      misc
      origin
    }
    misc
    prep_instructions { PrepOwner PrepInstruction }
    prep_owner
    label_owner
    lot_code
    packing_group_id
    updated
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Import PurchaseOrderItems

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation ImportPurchaseOrderItems(
  $batch_id: ID!,
  $items: [ImportPurchaseOrderItemInput!]!,
  $ShipToCountryCode: String,
  $send_prep_instructions: Boolean,
  $shipment_per_sku: Boolean
) {
  importPurchaseOrderItems(
    batch_id: $batch_id
    items: $items
    ShipToCountryCode: $ShipToCountryCode
    send_prep_instructions: $send_prep_instructions
    shipment_per_sku: $shipment_per_sku
  ) {
    _id
    batch_id
    inventory_id
    inventory {
      _id
      active
      msku
      fnsku
      quantity
      fba
      in_stock
      inbound
      transfer
      price
      payout
      misc
      product_id
      marketplace
      product {
        _id
        asin
        parent
        title
        image
        misc
        rank
        upc
        group
        marketplace
        expiration_required
        mapping {
          _id
          upc
          name
          products {
            _id
            quantity
            product {
              _id
              asin
            }
          }
        }
      }
      condition_id
      condition
      tax_code_id
      notes
      tags {
        _id
        name
        color
        url
      }
      prep_instructions {
        PrepOwner
        PrepInstruction
      }
      storage_type
      listings_issues {
        message
      }
      listings_issues_updated
      report_id
      must_send_feed
      active
      product_feed_batch_id
      product_feed_updated
      product_feed_status
      product_feed_errors
      inventory_feed_batch_id
      inventory_feed_updated
      inventory_feed_status
      inventory_feed_errors
      dimensions_feed_batch_id
      dimensions_feed_updated
      dimensions_feed_status
      dimensions_feed_errors
    }
    quantity
    quantity_in_case
    damaged
    purchase_order_batch_items {
      _id
      purchase_order_id
      purchase_order_name
      purchase_order_item_id
      quantity
    }
    deleted
    tags {
      _id
      name
      color
    }
    errors
    buylist {
      _id
      purchased
      quantity
      cost
      expires
      source
      created_by_name
      misc
      origin
    }
    shipments {
      id
      fcid
      prep
      quantity
      cp
    }
    misc
    prep_instructions {
      PrepOwner
      PrepInstruction
    }
    plans {
      plans {
        id
        fcid
        prep
        quantity
        requestId
        prep_instructions {
          PrepOwner
          PrepInstruction
        }
      }
      errors
      planning
    }
    plans_updated
    working_shipments {
      id
      fcid
      prep
      quantity
      cp
    }
    can_ship
    product_feed
    inventory_feed
    dimensions_feed
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get PackHistory

Get PackHistory

Authorizations:
basic_auth
query Parameters
start
string
Example: start=2025-01-01

Get items packed after this timestamp

end
string
Example: end=2025-02-01

Get items packed before this timestamp

created-by
string
Example: created-by=2f16c5b2-97d3-4238-8b89-22851363bf27

Optional comma-separated list of user ids to restrict to

shipment
string
Example: shipment=FBA18V17NFFD

Optional comma-separated list of shipment ids to restrict to

header Parameters
X-Requested-With
required
string
Example: XMLHttpRequest

Must be XMLHttpRequest

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Inventory

Select Inventory

All currency amounts are in the smallest currency unit (ie. cents) and are assumed to be in the currency that matches the marketplace (eg. USD for US, CAD for CA, etc.)

Authorizations:
bearer_auth
query Parameters
offset
integer

An integer offset used for paging. Defaults to 0

limit
integer

The number of rows to fetch. Defaults to 100

search
string

A search string. Requires 'search_by' to be set.

search_by
string
Enum: "gtin" "item_id" "sku" "title" "upc"

Field to search by. Required if 'search' is set. Accepts 'gtin', 'item_id', 'sku', 'title', or 'upc'.

channel
string
Enum: "az" "wm"

Optional channel to filter inventory by. Accepts 'az' for Amazon and 'wm' for Walmart.

latest
boolean

If true, returns inventory from the latest inventory report.

wfs
boolean

If true, returns WFS inventory. If false, returns SF inventory.

Responses

Response samples

Content type
application/json
{
  • "inventory": [
    ],
  • "total_rows": 0
}

Get Inventory

Inventory

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
query Inventory(
  $asins: [String!],
  $active: Boolean,
  $unlisted: Boolean,
  $limit: Int,
  $offset: Int,
  $marketplace: String,
  $filters: JSONObject,
  $ship_from: [ID],
  $sort_by: String
) {
  inventory(
    asins: $asins
    active: $active
    unlisted: $unlisted
    limit: $limit
    offset: $offset
    marketplace: $marketplace
    filters: $filters
    ship_from: $ship_from
    sort_by: $sort_by
  ) {
    _id
    active
    msku
    fnsku
    quantity
    fba
    in_stock
    inbound
    transfer
    price
    ceiling
    floor
    payout
    misc
    product_id
    marketplace
    product {
      _id
      asin
      parent
      title
      image
      misc
      rank
      upc
      group
    }
    condition_id
    condition
    tax_code_id
    notes
    ordered
    received
    damaged
    missing
    ship_from {
      ship_from_id
      ship_from_name
      ordered
      received
      damaged
      missing
    }
    tags {
      _id
      name
      color
      url
    }
    prep_instructions {
      PrepOwner
      PrepInstruction
    }
    storage_type
    listings_issues {
      message
    }
    listings_issues_updated
    report_id
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update InventoryItems

Update InventoryItems

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation UpdateInventoryItems(
  $marketplace: String,
  $items: [InventoryInput!]!
) {
  updateInventoryItems(
    marketplace: $marketplace,
    items: $items
  ) {
    _id
    msku
    product_id
    marketplace
    product { _id asin }
    condition_id
    condition
    tax_code_id
    notes
    tags { _id name color url }
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get ItemSetup by Match

Get ItemSetup by Match

Authorizations:
bearer_auth
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "MPItemFeedHeader": {
    },
  • "MPItem": [
    ]
}

Response samples

Content type
application/json
{
  • "feedId": "string"
}

Bulk Inventory Update

Bulk Inventory Update

Authorizations:
bearer_auth
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "InventoryHeader": {
    },
  • "Inventory": [
    ]
}

Response samples

Content type
application/json
{
  • "feedId": "string"
}

Get All FeedStatuses

Wrapper around Walmart's allFeedStatuses API

Authorizations:
bearer_auth
query Parameters
feedId
string

A unique ID returned from the Bulk Upload API, used for tracking the Feed File.

feedType
string

The feed type.

feedStatus
string

Status of the feed.

offset
string
Default: "0"

The object response to start with, where 0 is the first entity that can be requested.

limit
string
Default: "50"

The number of entities to be returned. It cannot be more than 50 entities.

header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "totalResults": 0,
  • "offset": 0,
  • "limit": 0,
  • "results": {
    }
}

Retire an Inventory Item

Wrapper around Walmart's retireAnItem API

Authorizations:
bearer_auth
path Parameters
sku
required
string

An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.

header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "sku": "string",
  • "message": "string"
}

WFS Shipment

Insert a Box

Insert a Box

Authorizations:
bearer_auth
Request Body schema: application/json
shipment_id
string

The shipment to create the box in

v1_batch_id
integer

The v1 batch to create the box in

v2_batch_id
integer <int64>

The v2 batch to create the box in

pallet_id
integer

Move the box to a pallet

quantity
integer

How many copies of this box there are

tracking_id
string

The tracking id

inbound_plan_id
required
string

The id of the inbound plan this box belongs to

packing_option_id
required
string

The id of the packing option this box belongs to

packing_group_id
string

The id of the packing group this box belongs to

length
integer

The length of the box in unit_of_measurement * 100

width
integer

The width of the box in unit_of_measurement * 100

height
integer

The height of the box in unit_of_measurement * 100

unit_of_measurement
string

CM | IN

weight
integer

The weight of the box in unit_of_weight * 100

unit_of_weight
string

KG | LB

Responses

Request samples

Content type
application/json
{
  • "shipment_id": "string",
  • "v1_batch_id": 0,
  • "v2_batch_id": 0,
  • "pallet_id": 0,
  • "quantity": 0,
  • "tracking_id": "string",
  • "inbound_plan_id": "string",
  • "packing_option_id": "string",
  • "packing_group_id": "string",
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "unit_of_measurement": "string",
  • "weight": 0,
  • "unit_of_weight": "string"
}

Response samples

Content type
application/json
{
  • "box": {
    }
}

Delete a Box

Delete a Box

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to delete

Responses

Response samples

Content type
application/json
{
  • "box": {
    }
}

Get a Box

Get a Box

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to get

Responses

Response samples

Content type
application/json
{
  • "box": {
    }
}

Delete Box

Update Box

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to update

Request Body schema: application/json
pallet_id
integer

Move the box to a pallet

quantity
integer

How many copies of this box there are

tracking_id
string

The tracking id

inbound_plan_id
required
string

The id of the inbound plan this box belongs to

packing_option_id
required
string

The id of the packing option this box belongs to

packing_group_id
string

The id of the packing group this box belongs to

length
integer

The length of the box in unit_of_measurement * 100

width
integer

The width of the box in unit_of_measurement * 100

height
integer

The height of the box in unit_of_measurement * 100

unit_of_measurement
string

CM | IN

weight
integer

The weight of the box in unit_of_weight * 100

unit_of_weight
string

KG | LB

Responses

Request samples

Content type
application/json
{
  • "pallet_id": 0,
  • "quantity": 0,
  • "tracking_id": "string",
  • "inbound_plan_id": "string",
  • "packing_option_id": "string",
  • "packing_group_id": "string",
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "unit_of_measurement": "string",
  • "weight": 0,
  • "unit_of_weight": "string"
}

Response samples

Content type
application/json
{
  • "box": {
    }
}

List BoxItems

List BoxItems

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to get

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Responses

Response samples

Content type
application/json
{
  • "box_items": [
    ],
  • "total_rows": 0
}

Insert BoxItem

Insert BoxItem

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to get

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Request Body schema: application/json
sku
required
string
external_id
required
string
expiration
string
fnsku
string
label_owner
string
manufacturing_lot_code
string
object
prep_owner
string
quantity
integer
packing_group_id
string

Responses

Request samples

Content type
application/json
{
  • "sku": "string",
  • "external_id": "string",
  • "expiration": "string",
  • "fnsku": "string",
  • "label_owner": "string",
  • "manufacturing_lot_code": "string",
  • "prep_instructions": {
    },
  • "prep_owner": "string",
  • "quantity": 0,
  • "packing_group_id": "string"
}

Response samples

Content type
application/json
{
  • "box_item": {
    }
}

Delete BoxItem

Delete BoxItem

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box in which the item to delete resides

sku
required
string

The SKU of the box item to delete

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Responses

Response samples

Content type
application/json
{
  • "box_item": {
    }
}

Update BoxItem

Update BoxItem

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box in which the item to update resides

sku
required
string

The SKU of the box item to update

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Request Body schema: application/json
expiration
string
fnsku
string
label_owner
string
manufacturing_lot_code
string
object
prep_owner
string
quantity
integer
packing_group_id
string

Responses

Request samples

Content type
application/json
{
  • "expiration": "string",
  • "fnsku": "string",
  • "label_owner": "string",
  • "manufacturing_lot_code": "string",
  • "prep_instructions": {
    },
  • "prep_owner": "string",
  • "quantity": 0,
  • "packing_group_id": "string"
}

Response samples

Content type
application/json
{
  • "box_item": {
    }
}

List Batches

Authorizations:
bearer_auth
query Parameters
batch_id
string

Select a specific batch by ID

archived
boolean

Filter by archived status (true/false)

offset
integer

Pagination offset

limit
integer

Pagination limit

inbound_order_id
string

Filter by inbound order ID (prefix match)

ship_from_id
string

Filter by ship from ID

Responses

Response samples

Content type
application/json
{
  • "batches": [
    ],
  • "total_rows": 0
}

Insert Batches

Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "batches": [
    ]
}

Response samples

Content type
application/json
{
  • "batches": [
    ],
  • "errors": [
    ]
}

Get Walmart Batch by ID

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

Select a specific batch by ID

query Parameters
archived
boolean

Filter by archived status (true/false)

offset
integer

Pagination offset

limit
integer

Pagination limit

inbound_order_id
string

Filter by inbound order ID (prefix match)

ship_from_id
string

Filter by ship from ID

Responses

Response samples

Content type
application/json
{
  • "batch": {
    }
}

Update Batches

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

Comma separated list of batch ids to update

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "batch": {
    }
}

Response samples

Content type
application/json
{
  • "batches": [
    ],
  • "errors": [
    ]
}

Delete Batches

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

A comma separated list of batch IDs

Responses

Response samples

Content type
application/json
{
  • "batches": [
    ],
  • "errors": [
    ]
}

List BatchItems

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

ID of the batch

Responses

Response samples

Content type
application/json
{
  • "total_rows": 0,
  • "batch_items": [
    ]
}

Insert BatchItems

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

ID of the batch

Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "batch_items": [
    ]
}

Response samples

Content type
application/json
{
  • "batch_items": [
    ]
}

Update BatchItems

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

ID of the batch

Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "batch_items": [
    ]
}

Response samples

Content type
application/json
{
  • "batch_items": [
    ],
  • "errors": [
    ]
}

Update BatchItem

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

ID of the batch

batch_item_id
required
string

ID of the batch item

Request Body schema: application/json
required
sku
string
quantity
integer
quantity_in_case
integer
object

Responses

Request samples

Content type
application/json
{
  • "sku": "string",
  • "quantity": 0,
  • "quantity_in_case": 0,
  • "item_prep": {
    }
}

Response samples

Content type
application/json
{
  • "batch_item": {
    }
}

Delete BatchItems

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

ID of the batch

batch_item_id
required
string

Comma separated list of batch item IDs

Responses

Response samples

Content type
application/json
{
  • "batch_item": {
    }
}

Get InboundShipments

Wrapper around Walmart's Get Shipments API

Authorizations:
bearer_auth
query Parameters
offset
string
Default: "0"
limit
string
Default: "10"
inboundOrderId
string
shipmentId
string
status
string
fromCreateDate
string <date-time>
toCreateDate
string <date-time>
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "headers": {
    },
  • "payload": [
    ]
}

Create InboundShipment

Wrapper around Walmart's Create Inbound Shipment API

Authorizations:
bearer_auth
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
inboundOrderId
required
string
object
required
object
required
Array of objects (wm.OrderItem)

length between 1 and 5000

Responses

Request samples

Content type
application/json
{
  • "inboundOrderId": "string",
  • "inboundServices": {
    },
  • "returnAddress": {
    },
  • "orderItems": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "payload": [
    ]
}

Fetch InboundPreview

Wrapper around Walmart's Fetch Inbound Preview API

Authorizations:
bearer_auth
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
object
object

Responses

Request samples

Content type
application/json
{
  • "header": {
    },
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "payload": [
    ]
}

Update Shipment Quantities

Wrapper around Walmart's Update Shipment Quantities API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string

ID of the shipment to update

header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
inboundOrderId
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "inboundOrderId": "string",
  • "orderItems": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "payload": { },
  • "errors": [
    ]
}

Update Walmart Shipment Tracking Details

Wrapper around Walmart's Update Shipment Tracking API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string

ID of the shipment to update

header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
carrierName
string
trackingInfo
Array of strings

Responses

Request samples

Content type
application/json
{
  • "carrierName": "string",
  • "trackingInfo": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "payload": { },
  • "errors": [
    ]
}

Create Carrier RateQuote

Wrapper around Walmart's Create Carrier Rate Quote API

Authorizations:
bearer_auth
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
shipmentId
required
string
shipmentSource
string
pickupFromDateTime
string
pickupToDateTime
string
deliveryFromDateTime
string
deliveryToDateTime
string
object
required
object
object
object
required
Array of objects (wm.ShipmentPackage)
mode
required
string (wm.Mode)
Enum: "PARCEL" "LTL" "FTL"
freightClass
string
declaredValue
integer
Array of objects

Responses

Request samples

Content type
application/json
{
  • "shipmentId": "string",
  • "shipmentSource": "string",
  • "pickupFromDateTime": "string",
  • "pickupToDateTime": "string",
  • "deliveryFromDateTime": "string",
  • "deliveryToDateTime": "string",
  • "customer": {
    },
  • "originLocation": {
    },
  • "destinationLocation": {
    },
  • "returnLocation": {
    },
  • "shipmentPackages": [
    ],
  • "mode": "PARCEL",
  • "freightClass": "string",
  • "declaredValue": 0,
  • "loadTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "shipmentId": "string",
  • "shipmentNumber": "string",
  • "rateQuotes": [
    ],
  • "errors": [
    ]
}

Get Carrier RateQuote

Wrapper around Walmart's Get Carrier Rate Quote API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string
mode
required
string (wm.Mode)
Enum: "PARCEL" "LTL" "FTL"
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "shipmentId": "string",
  • "quoteId": "string",
  • "estimatedDeliveryDateTime": "2019-08-24T14:15:22Z",
  • "quoteCreationDate": "2019-08-24T14:15:22Z",
  • "carrier": {
    },
  • "rateQuote": {
    },
  • "shipmentPackages": [
    ],
  • "originLocation": {
    },
  • "destinationLocation": {
    },
  • "returnLocation": {
    },
  • "errors": [
    ]
}

Cancel Carrier RateQutoe

Wrapper around Walmart's Cancel Carrier Rate Quote API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "header": { },
  • "payload": { },
  • "errors": [
    ]
}

Select Walmart Shipments from the database

Select Walmart shipments from the database

Authorizations:
bearer_auth
query Parameters
wm_shipment_id
string
inbound_order_id
string
source_address
string

Filter by ship from ID

offset
integer

Pagination offset

limit
integer

Pagination limit

Responses

Response samples

Content type
application/json
{
  • "total_rows": 0,
  • "wm_shipments": [
    ]
}

Select a single Walmart Shipment by Id

Select a single Walmart shipment by id

Authorizations:
bearer_auth
path Parameters
wm_shipment_id
required
string

Responses

Response samples

Content type
application/json
{
  • "wm_shipment": {
    }
}

Select Walmart Boxes from the database

Select Walmart boxes from the database

Authorizations:
bearer_auth
path Parameters
wm_shipment_id
required
string

Responses

Response samples

Content type
application/json
{
  • "total_rows": 0,
  • "boxes": [
    ]
}

Insert Walmart Boxes into our database

Insert Walmart boxes into our database

Authorizations:
bearer_auth
path Parameters
wm_shipment_id
required
string
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "boxes": {
    }
}

Response samples

Content type
application/json
{
  • "boxes": [
    ]
}

Update Walmart Boxes into our database

Update Walmart boxes into our database

Authorizations:
bearer_auth
path Parameters
wm_shipment_id
required
string
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "boxes": {
    }
}

Response samples

Content type
application/json
{
  • "boxes": [
    ],
  • "errors": [
    ]
}

Select a single Walmart Box by Id

Select a single Walmart box by id

Authorizations:
bearer_auth
path Parameters
wm_shipment_id
required
string
wm_box_id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "box": {
    }
}

Delete one or more Walmart Boxes by Id

Delete one or more Walmart boxes by id

Authorizations:
bearer_auth
path Parameters
wm_shipment_id
required
string
wm_box_id
required
string

A comma separated list of box ids

Responses

Response samples

Content type
application/json
{
  • "boxes": [
    ]
}

Create InboundShipment Label

Wrapper around Walmart's Create Inbound Shipment label API

Authorizations:
bearer_auth
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
shipmentId
required
string
labelSize
string
Enum: "X4_6" "X4_3"
labelFormat
string
Enum: "PDF" "ZPL"
Array of objects

Responses

Request samples

Content type
application/json
{
  • "shipmentId": "string",
  • "labelSize": "X4_6",
  • "labelFormat": "PDF",
  • "loadTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Print Walmart Carrier Label

Wrapper around Walmart's Print Carrier Label API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
shipDate
required
string <date-time>

Full timestamp with microsecond precision required

Responses

Request samples

Content type
application/json
{
  • "shipDate": "2025-08-22T00:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get InboundShipment Errors

Wrapper around Walmart's Get Inbound Shipment errors API

Authorizations:
bearer_auth
query Parameters
offset
string
Default: "0"
limit
string
Default: "10"
inboundOrderId
string
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "headers": {
    },
  • "payload": [
    ]
}

Get InboundShipment Items

Wrapper around Walmart's Get Inbound Shipment Items API

Authorizations:
bearer_auth
query Parameters
offset
string
Default: "0"
limit
string
Default: "10"
shipmentId
string
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "headers": {
    },
  • "payload": [
    ]
}

Cancel InboundShipment

Wrapper around Walmart's Cancel Inbound Shipment API

Authorizations:
bearer_auth
path Parameters
inboundOrderId
required
string
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "header": { },
  • "payload": { },
  • "errors": [
    ]
}

Inventory

Select Inventory

All currency amounts are in the smallest currency unit (ie. cents) and are assumed to be in the currency that matches the marketplace (eg. USD for US, CAD for CA, etc.)

Authorizations:
bearer_auth
query Parameters
offset
integer

An integer offset used for paging. Defaults to 0

limit
integer

The number of rows to fetch. Defaults to 100

search
string

A search string. Requires 'search_by' to be set.

search_by
string
Enum: "gtin" "item_id" "sku" "title" "upc"

Field to search by. Required if 'search' is set. Accepts 'gtin', 'item_id', 'sku', 'title', or 'upc'.

channel
string
Enum: "az" "wm"

Optional channel to filter inventory by. Accepts 'az' for Amazon and 'wm' for Walmart.

latest
boolean

If true, returns inventory from the latest inventory report.

wfs
boolean

If true, returns WFS inventory. If false, returns SF inventory.

Responses

Response samples

Content type
application/json
{
  • "inventory": [
    ],
  • "total_rows": 0
}

Get Inventory

Inventory

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
query Inventory(
  $asins: [String!],
  $active: Boolean,
  $unlisted: Boolean,
  $limit: Int,
  $offset: Int,
  $marketplace: String,
  $filters: JSONObject,
  $ship_from: [ID],
  $sort_by: String
) {
  inventory(
    asins: $asins
    active: $active
    unlisted: $unlisted
    limit: $limit
    offset: $offset
    marketplace: $marketplace
    filters: $filters
    ship_from: $ship_from
    sort_by: $sort_by
  ) {
    _id
    active
    msku
    fnsku
    quantity
    fba
    in_stock
    inbound
    transfer
    price
    ceiling
    floor
    payout
    misc
    product_id
    marketplace
    product {
      _id
      asin
      parent
      title
      image
      misc
      rank
      upc
      group
    }
    condition_id
    condition
    tax_code_id
    notes
    ordered
    received
    damaged
    missing
    ship_from {
      ship_from_id
      ship_from_name
      ordered
      received
      damaged
      missing
    }
    tags {
      _id
      name
      color
      url
    }
    prep_instructions {
      PrepOwner
      PrepInstruction
    }
    storage_type
    listings_issues {
      message
    }
    listings_issues_updated
    report_id
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update InventoryItems

Update InventoryItems

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation UpdateInventoryItems(
  $marketplace: String,
  $items: [InventoryInput!]!
) {
  updateInventoryItems(
    marketplace: $marketplace,
    items: $items
  ) {
    _id
    msku
    product_id
    marketplace
    product { _id asin }
    condition_id
    condition
    tax_code_id
    notes
    tags { _id name color url }
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get ItemSetup by Match

Get ItemSetup by Match

Authorizations:
bearer_auth
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "MPItemFeedHeader": {
    },
  • "MPItem": [
    ]
}

Response samples

Content type
application/json
{
  • "feedId": "string"
}

Bulk Inventory Update

Bulk Inventory Update

Authorizations:
bearer_auth
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "InventoryHeader": {
    },
  • "Inventory": [
    ]
}

Response samples

Content type
application/json
{
  • "feedId": "string"
}

Get All FeedStatuses

Wrapper around Walmart's allFeedStatuses API

Authorizations:
bearer_auth
query Parameters
feedId
string

A unique ID returned from the Bulk Upload API, used for tracking the Feed File.

feedType
string

The feed type.

feedStatus
string

Status of the feed.

offset
string
Default: "0"

The object response to start with, where 0 is the first entity that can be requested.

limit
string
Default: "50"

The number of entities to be returned. It cannot be more than 50 entities.

header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "totalResults": 0,
  • "offset": 0,
  • "limit": 0,
  • "results": {
    }
}

Retire an Inventory Item

Wrapper around Walmart's retireAnItem API

Authorizations:
bearer_auth
path Parameters
sku
required
string

An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.

header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "sku": "string",
  • "message": "string"
}

Printing

Create Marketplace ItemLabels

Wrapper around Amazon's createMarketplaceItemLabels API

Authorizations:
bearer_auth
header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
height
integer
labelType
string
Enum: "STANDARD_FORMAT" "THERMAL_PRINTING"
localeCode
string
marketplaceId
string (MarketplaceId)
Array of objects
pageType
string
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"
width
integer

Responses

Request samples

Content type
application/json
{
  • "height": 0,
  • "labelType": "STANDARD_FORMAT",
  • "localeCode": "string",
  • "marketplaceId": "ATVPDKIKX0DER",
  • "mskuQuantities": [
    ],
  • "pageType": "A4_21",
  • "width": 0
}

Response samples

Content type
application/json
{
  • "documentDownloads": [
    ]
}

Get Labels

Wrapper around Amazon's getLabels API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string
query Parameters
PageType
required
string
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"
LabelType
required
string
Enum: "BARCODE_2D" "UNIQUE" "PALLET"
NumberOfPackages
integer
PackageLabelsToPrint
Array of strings
NumberOfPallets
integer
PageSize
integer
PageStartIndex
integer
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "payload": {
    }
}

Generate item labels

Authorizations:
bearer_auth
header Parameters
Accept
string
Value: "application/pdf"

Specify application/pdf and the response body will be raw PDF data

Request Body schema: application/json
label_width
required
number

The width of the label in inches

label_height
required
number

The height of the label in inches

required
Array of objects

A list of items to generate labels for

object

Responses

Request samples

Content type
application/json
{
  • "label_width": 0,
  • "label_height": 0,
  • "items": [
    ],
  • "opts": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

FBA Inbound Shipment

List InboundPlans

Wrapper around Amazon's listInboundPlans API

Authorizations:
bearer_auth
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
status
string
Enum: "ACTIVE" "VOIDED" "SHIPPED"
sortBy
string
Enum: "LAST_UPDATED_TIME" "CREATION_TIME"
sortOrder
string
Enum: "ASC" "DESC"
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "inboundPlans": [
    ],
  • "pagination": {
    }
}

Create Inbound Plan

Wrapper around Amazon's createInboundPlan API

Authorizations:
bearer_auth
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
destinationMarketplaces
Array of strings
Array of objects (ItemInput)
name
string
object (spapi.AddressInput)

Responses

Request samples

Content type
application/json
{
  • "destinationMarketplaces": [
    ],
  • "items": [
    ],
  • "name": "string",
  • "sourceAddress": {
    }
}

Response samples

Content type
application/json
{
  • "inboundPlanId": "string",
  • "operationId": "string"
}

Get Inbound Plan

Wrapper around Amazon's getInboundPlan API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "inboundPlanId": "string",
  • "lastUpdatedAt ": "string",
  • "marketplaceIds": [
    ],
  • "name": "string",
  • "packingOptions": [
    ],
  • "placementOptions": [
    ],
  • "shipments": [
    ],
  • "sourceAddress": {
    },
  • "status": "ACTIVE"
}

List InboundPlan Boxes

Wrapper around Amazon's listInboundPlanBoxes API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "boxes": [
    ],
  • "pagination": {
    }
}

List InboundPlan Items

Wrapper around Amazon's listInboundPlanItems API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Update InboundPlan Name

Wrapper around Amazon's updateInboundPlanName API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List PackingGroup Boxes

Wrapper around Amazon's listPackingGroupBoxes API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
packingGroupId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "boxes": [
    ],
  • "pagination": {
    }
}

List PackingGroup Items

Wrapper around Amazon's listPackingGroupItems API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
packingGroupId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Set Packing Information

Wrapper around Amazon's setPackingInformation API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "packageGroupings": [
    ]
}

Response samples

Content type
application/json
{
  • "operationId": "string"
}

List Packing Options

Wrapper around Amazon's listPackingOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "packingOptions": [
    ],
  • "pagination": {
    }
}

Generate Packing Options

Wrapper around Amazon's generatePackingOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

list
integer
Value: 1
Example: list=1

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.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
Example
{
  • "operationId": "string"
}

Confirm Packing Option

Wrapper around Amazon's confirmPackingOption API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
packingOptionId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operationId": "string"
}

List InboundPlan Pallets

Wrapper around Amazon's listInboundPlanPallets API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "pallets": [
    ]
}

List Placement Options

Wrapper around Amazon's listPlacementOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "placementOptions": [
    ]
}

Generate Placement Options

Wrapper around Amazon's generatePlacementOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

list
integer
Value: 1
Example: list=1

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.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Confirm Placement Option

Wrapper around Amazon's confirmPlacementOption API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
placementOptionId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Get Shipment

Wrapper around Amazon's getShipment API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "amazonReferenceId": "string",
  • "contactInformation": {
    },
  • "dates": {
    },
  • "destination ": {
    },
  • "freightInformation": {
    },
  • "name": "string",
  • "placementOptionId": "string",
  • "selectedDeliveryWindow": {
    },
  • "selectedTransportationOptionId ": "string",
  • "selfShipAppointmentDetails ": [
    ],
  • "shipmentConfirmationId": "string",
  • "shipmentId": "string",
  • "source": {
    },
  • "status": "ABANDONED",
  • "trackingDetails": {
    }
}

List Shipment Boxes

Wrapper around Amazon's listShipmentBoxes API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "boxes": [
    ],
  • "pagination": {
    }
}

List ShipmentContent UpdatePreviews

Wrapper around Amazon's listShipmentContentUpdatePreviews API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "contentUpdatePreviews": [
    ],
  • "pagination": {
    }
}

Generate ShipmentContent UpdatePreviews

Wrapper around Amazon's generateShipmentContentUpdatePreviews API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
Array of objects (BoxUpdateInput)
Array of objects (ItemInput)

Responses

Request samples

Content type
application/json
{
  • "boxes": [
    ],
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Get ShipmentContent UpdatePreview

Wrapper around Amazon's getShipmentContentUpdatePreview API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
contentUpdatePreviewId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "contentUpdatePreviewId": "string",
  • "expiration": "string",
  • "requestedUpdates": {
    },
  • "transportationOption": {
    }
}

Confirm ShipmentContent UpdatePreview

Wrapper around Amazon's confirmShipmentContentUpdatePreview API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
contentUpdatePreviewId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Get DeliveryChallan Document

Wrapper around Amazon's getDeliveryChallanDocument API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "documentDownload ": {
    }
}

List DeliveryWindow Options

Wrapper around Amazon's listDeliveryWindowOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "deliveryWindowOptions": [
    ],
  • "pagination": {
    }
}

Generate DeliveryWindow Options

Wrapper around Amazon's generateDeliveryWindowOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Confirm DeliveryWindow Options

Wrapper around Amazon's confirmDeliveryWindowOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
deliveryWindowOptionId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operationId": "string"
}

List ShipmentItems

Wrapper around Amazon's listShipmentItems API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}

Update Shipment Name

Wrapper around Amazon's updateShipmentName API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

List Shipment Pallets

Wrapper around Amazon's listShipmentPallets API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "pallets": [
    ]
}

Cancel SelfShip Appointment

Wrapper around Amazon's cancelSelfShipAppointment API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
reasonComment
string
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"

Responses

Request samples

Content type
application/json
{
  • "reasonComment": "APPOINTMENT_REQUESTED_BY_MISTAKE"
}

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Get SelfShip Appointment Slots

Wrapper around Amazon's getSelfShipAppointmentSlots API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "selfShipAppointmentSlotsAvailability": {
    }
}

Generate SelfShip Appointment Slots

Wrapper around Amazon's generateSelfShipAppointmentSlots API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
desiredEndDate
string
desiredStartDate
string

Responses

Request samples

Content type
application/json
{
  • "desiredEndDate": "string",
  • "desiredStartDate": "string"
}

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Schedule SelfShip Appointment

Wrapper around Amazon's scheduleSelfShipAppointment API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
slotId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
reasonComment
string
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"

Responses

Request samples

Content type
application/json
{
  • "reasonComment": "APPOINTMENT_REQUESTED_BY_MISTAKE"
}

Response samples

Content type
application/json
{
  • "selfShipAppointmentDetails": {
    }
}

Update ShipmentSource Address

Wrapper around Amazon's updateShipmentSourceAddress API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
One of
object (spapi.AddressInput)

Responses

Request samples

Content type
application/json
{
  • "source_id": 0
}

Response samples

Content type
application/json
Example
{
  • "operationId": "string"
}

Update Shipment TrackingDetails

Wrapper around Amazon's updateShipmentTrackingDetails API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
shipmentId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json

Responses

Request samples

Content type
application/json
{
  • "trackingDetails": {
    }
}

Response samples

Content type
application/json
Example
{
  • "operationId": "string"
}

List Transportation Options

Wrapper around Amazon's listTransportationOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
pageSize
integer
Example: pageSize=10
paginationToken
string
placementOptionId
string
shipmentId
string
allPages
integer
Value: 1
Example: allPages=1

Attempt to get all pages by auto-paging server-side. May be slow or timeout for large datasets.

header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "transportationOptions": [
    ]
}

Generate Transportation Options

Wrapper around Amazon's generateTransportationOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

list
integer
Value: 1
Example: list=1

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.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
placementOptionId
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "placementOptionId": "string",
  • "shipmentTransportationConfigurations": [
    ]
}

Response samples

Content type
application/json
{
  • "operationId": "string"
}

Confirm Transportation Options

Wrapper around Amazon's confirmTransportationOptions API

Authorizations:
bearer_auth
path Parameters
inboundPlanId
required
string
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "transportationSelections ": [
    ]
}

Response samples

Content type
application/json
{
  • "operationId": "string"
}

List ItemCompliance Details

Wrapper around Amazon's listItemComplianceDetails API

Authorizations:
bearer_auth
query Parameters
mskus
required
Array of strings
marketplaceId
required
string (MarketplaceId)
Example: marketplaceId=ATVPDKIKX0DER
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "complianceDetails": [
    ]
}

Update ItemCompliance Details

Wrapper around Amazon's updateItemComplianceDetails API

Authorizations:
bearer_auth
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
msku
string
object (spapi.TaxDetails)

Responses

Request samples

Content type
application/json
{
  • "msku": "string",
  • "taxDetails": {
    }
}

Response samples

Content type
application/json
Example
{
  • "operationId": "string"
}

Create Marketplace ItemLabels

Wrapper around Amazon's createMarketplaceItemLabels API

Authorizations:
bearer_auth
header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
height
integer
labelType
string
Enum: "STANDARD_FORMAT" "THERMAL_PRINTING"
localeCode
string
marketplaceId
string (MarketplaceId)
Array of objects
pageType
string
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"
width
integer

Responses

Request samples

Content type
application/json
{
  • "height": 0,
  • "labelType": "STANDARD_FORMAT",
  • "localeCode": "string",
  • "marketplaceId": "ATVPDKIKX0DER",
  • "mskuQuantities": [
    ],
  • "pageType": "A4_21",
  • "width": 0
}

Response samples

Content type
application/json
{
  • "documentDownloads": [
    ]
}

List Prep Details

Wrapper around Amazon's listPrepDetails API

Authorizations:
bearer_auth
query Parameters
marketplaceId
required
string (MarketplaceId)
Example: marketplaceId=ATVPDKIKX0DER
mskus
required
Array of strings
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "mskuPrepDetails": [
    ]
}

Set Prep Details

Wrapper around Amazon's setPrepDetails API

Authorizations:
bearer_auth
query Parameters
operationComplete
integer
Value: 1
Example: operationComplete=1

Repeatedly poll getInboundOperationStatus on the returned operationId until the operation finishes and return the results of that instead of just the operationId.

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
marketplaceId
string (MarketplaceId)
Array of objects

Responses

Request samples

Content type
application/json
{
  • "marketplaceId": "ATVPDKIKX0DER",
  • "mskuPrepDetails": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "operationId": "string"
}

Get InboundOperation Status

Wrapper around Amazon's getInboundOperationStatus API

Authorizations:
bearer_auth
path Parameters
operationId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "operation": "string",
  • "operationId": "string",
  • "operationProblems": [
    ],
  • "operationStatus": "SUCCESS"
}

Get BillOfLading

Wrapper around Amazon's getBillOfLading API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "payload": {
    }
}

Get Labels

Wrapper around Amazon's getLabels API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string
query Parameters
PageType
required
string
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"
LabelType
required
string
Enum: "BARCODE_2D" "UNIQUE" "PALLET"
NumberOfPackages
integer
PackageLabelsToPrint
Array of strings
NumberOfPallets
integer
PageSize
integer
PageStartIndex
integer
header Parameters
x-access-token
required
string

An Amazon API access token

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "payload": {
    }
}

Get InboundPlans

Load the inbound plans associated with the given batch

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

Responses

Response samples

Content type
application/json
{
  • "inbound_plans": [
    ],
  • "total_rows": 0
}

Create an inbound plan from the items in the provided batch

Create an inbound plan from the items in the provided batch

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "inbound_plan": {
    }
}

Submit Boxes

Send packed box information to Amazon

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "placement_options": [
    ]
}

List boxes for a v1 Amazon batch

List boxes for a v1 Amazon batch

Authorizations:
bearer_auth
query Parameters
v1_batch_id
string

The id of the v1 batch to load boxes for

v2_batch_id
string

The id of the v2 batch to load boxes for

shipment_id
string

The id of the v2 shipment to load boxes for

with
Array of strings
Items Enum: "configuration" "box_items"

Comma separated list of zero or more of configuration or box_items.

Responses

Response samples

Content type
application/json
{
  • "boxes": [
    ],
  • "total_rows": 0
}

Insert a Box

Insert a Box

Authorizations:
bearer_auth
Request Body schema: application/json
shipment_id
string

The shipment to create the box in

v1_batch_id
integer

The v1 batch to create the box in

v2_batch_id
integer <int64>

The v2 batch to create the box in

pallet_id
integer

Move the box to a pallet

quantity
integer

How many copies of this box there are

tracking_id
string

The tracking id

inbound_plan_id
required
string

The id of the inbound plan this box belongs to

packing_option_id
required
string

The id of the packing option this box belongs to

packing_group_id
string

The id of the packing group this box belongs to

length
integer

The length of the box in unit_of_measurement * 100

width
integer

The width of the box in unit_of_measurement * 100

height
integer

The height of the box in unit_of_measurement * 100

unit_of_measurement
string

CM | IN

weight
integer

The weight of the box in unit_of_weight * 100

unit_of_weight
string

KG | LB

Responses

Request samples

Content type
application/json
{
  • "shipment_id": "string",
  • "v1_batch_id": 0,
  • "v2_batch_id": 0,
  • "pallet_id": 0,
  • "quantity": 0,
  • "tracking_id": "string",
  • "inbound_plan_id": "string",
  • "packing_option_id": "string",
  • "packing_group_id": "string",
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "unit_of_measurement": "string",
  • "weight": 0,
  • "unit_of_weight": "string"
}

Response samples

Content type
application/json
{
  • "box": {
    }
}

Delete a Box

Delete a Box

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to delete

Responses

Response samples

Content type
application/json
{
  • "box": {
    }
}

Get a Box

Get a Box

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to get

Responses

Response samples

Content type
application/json
{
  • "box": {
    }
}

Delete Box

Update Box

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to update

Request Body schema: application/json
pallet_id
integer

Move the box to a pallet

quantity
integer

How many copies of this box there are

tracking_id
string

The tracking id

inbound_plan_id
required
string

The id of the inbound plan this box belongs to

packing_option_id
required
string

The id of the packing option this box belongs to

packing_group_id
string

The id of the packing group this box belongs to

length
integer

The length of the box in unit_of_measurement * 100

width
integer

The width of the box in unit_of_measurement * 100

height
integer

The height of the box in unit_of_measurement * 100

unit_of_measurement
string

CM | IN

weight
integer

The weight of the box in unit_of_weight * 100

unit_of_weight
string

KG | LB

Responses

Request samples

Content type
application/json
{
  • "pallet_id": 0,
  • "quantity": 0,
  • "tracking_id": "string",
  • "inbound_plan_id": "string",
  • "packing_option_id": "string",
  • "packing_group_id": "string",
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "unit_of_measurement": "string",
  • "weight": 0,
  • "unit_of_weight": "string"
}

Response samples

Content type
application/json
{
  • "box": {
    }
}

List BoxItems

List BoxItems

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to get

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Responses

Response samples

Content type
application/json
{
  • "box_items": [
    ],
  • "total_rows": 0
}

Insert BoxItem

Insert BoxItem

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to get

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Request Body schema: application/json
sku
required
string
external_id
required
string
expiration
string
fnsku
string
label_owner
string
manufacturing_lot_code
string
object
prep_owner
string
quantity
integer
packing_group_id
string

Responses

Request samples

Content type
application/json
{
  • "sku": "string",
  • "external_id": "string",
  • "expiration": "string",
  • "fnsku": "string",
  • "label_owner": "string",
  • "manufacturing_lot_code": "string",
  • "prep_instructions": {
    },
  • "prep_owner": "string",
  • "quantity": 0,
  • "packing_group_id": "string"
}

Response samples

Content type
application/json
{
  • "box_item": {
    }
}

Delete BoxItem

Delete BoxItem

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box in which the item to delete resides

sku
required
string

The SKU of the box item to delete

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Responses

Response samples

Content type
application/json
{
  • "box_item": {
    }
}

Update BoxItem

Update BoxItem

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box in which the item to update resides

sku
required
string

The SKU of the box item to update

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Request Body schema: application/json
expiration
string
fnsku
string
label_owner
string
manufacturing_lot_code
string
object
prep_owner
string
quantity
integer
packing_group_id
string

Responses

Request samples

Content type
application/json
{
  • "expiration": "string",
  • "fnsku": "string",
  • "label_owner": "string",
  • "manufacturing_lot_code": "string",
  • "prep_instructions": {
    },
  • "prep_owner": "string",
  • "quantity": 0,
  • "packing_group_id": "string"
}

Response samples

Content type
application/json
{
  • "box_item": {
    }
}

List Pallets

List Pallets

Authorizations:
bearer_auth
query Parameters
v1_batch_id
string

The id of the v1 batch to load pallets for

v2_batch_id
string

The id of the v2 batch to load pallets for

shipment_id
string

The id of the v2 shipment to load pallets for

Responses

Response samples

Content type
application/json
{
  • "boxes": [
    ],
  • "total_rows": 0
}

Insert Pallet

Insert Pallet

Authorizations:
bearer_auth
Request Body schema: application/json
shipment_id
string

The shipment to create the pallet in

v1_batch_id
integer

The v1 batch to create the pallet in

v2_batch_id
integer <int64>

The v2 batch to create the pallet in

quantity
integer

How many copies of this pallet there are

stackability
string (Stackability)
Enum: "STACKABLE" "NON_STACKABLE"
inbound_plan_id
string

The id of the inbound plan this pallet belongs to

placement_option_id
string

The id of the placement option this pallet belongs to

length
integer

The length of the pallet in unit_of_measurement * 100

width
integer

The width of the pallet in unit_of_measurement * 100

height
integer

The height of the pallet in unit_of_measurement * 100

unit_of_measurement
string

CM | IN

weight
integer

The weight of the pallet in unit_of_weight * 100

unit_of_weight
string

KG | LB

Responses

Request samples

Content type
application/json
{
  • "shipment_id": "string",
  • "v1_batch_id": 0,
  • "v2_batch_id": 0,
  • "quantity": 0,
  • "stackability": "STACKABLE",
  • "inbound_plan_id": "string",
  • "placement_option_id": "string",
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "unit_of_measurement": "string",
  • "weight": 0,
  • "unit_of_weight": "string"
}

Response samples

Content type
application/json
{
  • "pallet": {
    }
}

Delete Pallet

Delete Pallet

Authorizations:
bearer_auth
path Parameters
pallet_id
required
string

The id of the pallet to delete

Responses

Response samples

Content type
application/json
{
  • "pallet": {
    }
}

List Pallet

List Pallet

Authorizations:
bearer_auth
path Parameters
pallet_id
required
string

The id of the pallet to get

Responses

Response samples

Content type
application/json
{
  • "pallet": {
    }
}

Update Pallet

Update Pallet

Authorizations:
bearer_auth
path Parameters
pallet_id
required
string

The id of the pallet to update

Request Body schema: application/json
quantity
integer

How many copies of this pallet there are

stackability
string (Stackability)
Enum: "STACKABLE" "NON_STACKABLE"
inbound_plan_id
string

The id of the inbound plan this pallet belongs to

placement_option_id
string

The id of the placement option this pallet belongs to

length
integer

The length of the pallet in unit_of_measurement * 100

width
integer

The width of the pallet in unit_of_measurement * 100

height
integer

The height of the pallet in unit_of_measurement * 100

unit_of_measurement
string

CM | IN

weight
integer

The weight of the pallet in unit_of_weight * 100

unit_of_weight
string

KG | LB

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "stackability": "STACKABLE",
  • "inbound_plan_id": "string",
  • "placement_option_id": "string",
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "unit_of_measurement": "string",
  • "weight": 0,
  • "unit_of_weight": "string"
}

Response samples

Content type
application/json
{
  • "pallet": {
    }
}

Get a list of Purchase Orders.

Get a list of Purchase Orders.

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
query PurchaseOrders(
  $marketplace: String,
  $archived: Boolean,
  $deleted: Boolean,
  $search: [String],
  $ship_from: [ID],
  $received: Boolean,
  $can_add_to_batch: Boolean,
  $has_unreceived: Boolean,
  $purchase_order_id: ID,
  $external_id: String,
  $shipment_ids: [ID],
) {
  purchaseOrders(
    marketplace: $marketplace
    archived: $archived
    deleted: $deleted
    search: $search
    ship_from: $ship_from
    received: $received
    can_add_to_batch: $can_add_to_batch
    has_unreceived: $has_unreceived
    purchase_order_id: $purchase_order_id
    external_id: $external_id
    shipment_ids: $shipment_ids,
  ) {
    _id
    external_id
    name
    ship_from_id
    ship_from
    created
    deleted
    archived
    total_count
    total_ordered
    total_received
    total_shipped
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a single purchase order.

Create a single purchase order.

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation CreatePurchaseOrder(
  $ship_from: ID!,
  $marketplace: String!,
  $name: String,
  $external_id: String,
) {
  createPurchaseOrder(
    ship_from: $ship_from
    marketplace: $marketplace
    name: $name
    external_id: $external_id
  ) {
    _id
    external_id
    name
    ship_from_id
    ship_from
    created
    deleted
    archived
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a purchase order. This does not change any of the items in the PO.

Update a purchase order. This does not change any of the items in the PO.

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation UpdatePurchaseOrder(
  $purchase_order_id: ID!,
  $ship_from: ID,
  $name: String,
  $external_id: String,
  $archived: Boolean,
  $deleted: Boolean
) {
  updatePurchaseOrder(
    purchase_order_id: $purchase_order_id
    ship_from: $ship_from
    name: $name
    external_id: $external_id
    archived: $archived
    deleted: $deleted
  ) {
    _id
    external_id
    name
    ship_from_id
    ship_from
    created
    deleted
    archived
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of purchase order items.

Get a list of purchase order items.

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
query PurchaseOrderItems(
  $purchase_order_ids: [ID],
  $search: String,
  $received: Boolean,
  $can_add_to_batch: Boolean,
  $ship_from: [ID]
) {
  purchaseOrderItems(
    purchase_order_ids: $purchase_order_ids
    search: $search
    received: $received
    can_add_to_batch: $can_add_to_batch
    ship_from: $ship_from
  ) {
    _id
    purchase_order_id
    inventory_id
    inventory {
      msku
      condition
      fnsku
      price
      product {
        asin
        title
        image
        misc
        rank
        upc
        group
        marketplace
        expiration_required
        mapping {
          _id
          upc
          name
          products {
            _id
            quantity
            product {
              _id
              asin
            }
          }
        }
      }
    }
    ordered
    received
    in_batch
    damaged
    missing
    notes
    multipack
    created
    updated
    deleted
    cost
    expires
    batch_items {
      _id
      quantity
      shipments {
        id
        cp
        fcid
        prep
        quantity
        status
      }
    }
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Add items to a purchase order.

Add items to a purchase order.

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation CreatePurchaseOrderItems(
  $purchase_order_id: ID!,
  $items: [PurchaseOrderItemInput!]
) {
  createPurchaseOrderItems(
    purchase_order_id: $purchase_order_id,
    items: $items
  ) {
    _id
    purchase_order_id
    inventory_id
    inventory {
      msku
      condition
      fnsku
      price
      product {
        asin
        title
        image
        misc
        rank
        upc
        group
        marketplace
        expiration_required
        mapping {
          _id
          upc
          name
          products {
            _id
            quantity
            product {
              _id
              asin
            }
          }
        }
      }
    }
    ordered
    received
    in_batch
    damaged
    missing
    notes
    multipack
    created
    updated
    deleted
    cost
    expires
    batch_items {
      _id
      quantity
      shipments {
        id
        cp
        fcid
        prep
        quantity
        status
      }
    }
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a single purchase order item.

Update a single purchase order item.

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation UpdatePurchaseOrderItem(
  $purchase_order_item_id: ID!,
  $item: PurchaseOrderItemInput!
) {
  updatePurchaseOrderItem(
    purchase_order_item_id: $purchase_order_item_id
    item: $item
  ) {
    _id
    purchase_order_id
    inventory_id
    inventory {
      msku
      condition
      fnsku
      price
      product {
        asin
        title
        image
        misc
        rank
        upc
        group
        marketplace
        expiration_required
        mapping {
          _id
          upc
          name
          products {
            _id
            quantity
            product {
              _id
              asin
            }
          }
        }
      }
    }
    ordered
    received
    in_batch
    damaged
    missing
    notes
    multipack
    created
    updated
    deleted
    cost
    expires
    batch_items {
      _id
      quantity
      shipments {
        id
        cp
        fcid
        prep
        quantity
        status
      }
    }
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Batches

Get Batches

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
query Batches(
  $marketplace: String
  $archived: Boolean
  $deleted: Boolean
  $search: [String]
  $ship_from: [ID]
  $batch_id: ID
  $purchase_order_id: ID
  $limit: Int
) {
  batches(
    marketplace: $marketplace
    archived: $archived
    deleted: $deleted
    search: $search
    ship_from:$ship_from
    batch_id: $batch_id
    purchase_order_id: $purchase_order_id
   limit: $limit
  ) {
    _id
    name
    marketplace
    ship_from_id
    ship_from
    fba
    multipack
    created
    archived
    deleted
    tags {
      _id
      name
      color
    }
    total_quantity
    total_count
    shipments
    purchase_order_id
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create Batch

Create Batch

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation CreateBatch(
  $ship_from: ID!,
  $marketplace: String!,
  $name: String,
  $tags: [TagInput]
) {
  createBatch(
    ship_from: $ship_from,
    marketplace: $marketplace,
    name: $name,
    tags: $tags
  ) {
    _id
    name
    marketplace
    ship_from_id
    ship_from
    fba
    multipack
    created
    archived
    deleted
    tags {
      _id
      name
      color
    }
    total_quantity
    total_count
    shipments
    purchase_order_id
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Batch

Update Batch

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation 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) {
  updateBatch(
    batch_id: $batch_id
    ship_from: $ship_from
    fba: $fba
    purchase_order_id: $purchase_order_id
    name: $name
    archived: $archived
    deleted: $deleted
    tags: $tags
    prep_type: $prep_type
    current_step: $current_step
    flow: $flow
  ) {
    _id
    name
    marketplace
    ship_from_id
    ship_from
    fba
    created
    archived
    deleted
    tags {
      _id
      name
      color
    }
    total_quantity
    total_count
    shipments
    total_in_shipments
    misc
    batch_type
    carryover_for
    feed_errors
    prep_type
    dirty
    disabled
    purchase_order_id
    current_step
    flow
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get BatchItems

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
query BatchItems($batchId: ID) {
  batchSummary(batch_id: $batchId) {
    batch_id
    total_cost
    total_payout
    avg_rank
    creating_listings
  }
  batchItems(batch_id: $batchId) {
    _id
    batch_id
    inventory_id
    inventory {
      _id
      active
      msku
      fnsku
      quantity
      fba
      in_stock
      inbound
      transfer
      price
      payout
      misc
      product_id
      marketplace
      product {
        _id
        asin
        parent
        title
        image
        misc
        rank
        upc
        group
        marketplace
        expiration_required
        product_type
      }
      condition_id
      condition
      tax_code_id
      notes
      tags { _id name color url icon }
      prep_instructions {PrepOwner PrepInstruction}
      prep_details { prepCategory prepTypes allOwnersConstraint prepOwnerConstraint labelOwnerConstraint }
      storage_type
      listings_issues { code message severity attributeNames categories }
      listings_issues_updated
      listings_item { fulfillmentAvailability submitted attributes dimensionsSubmitted }
      listings_status
      update_listings_at
      update_listings_issues
      report_id
    }
    quantity
    unshipped
    quantity_in_case
    damaged
    deleted
    tags { _id name color }
    errors
    buylist {
      _id
      purchased
      quantity
      cost
      expires
      source
      created_by_name
      misc
      origin
    }
    misc
    prep_instructions { PrepOwner PrepInstruction }
    prep_owner
    label_owner
    lot_code
    packing_group_id
    updated
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

CreateBatchItems

Authorizations:
bearer_auth
query Parameters
op
required
string
Value: "CreateBatchItems"

GraphQL query

header Parameters
x-access-token
required
string

An Amazon API access token

Request Body schema: application/json
query
string
mutation CreateBatchItems(
  $batch_id: ID!,
  $items: [BatchItemInput!],
  $marketplace: String!,
  $manuallyCreateFbaListings: Boolean,
) {
  createBatchItems(
    batch_id: $batch_id,
    items: $items,
    marketplace: $marketplace,
    manuallyCreateFbaListings: $manuallyCreateFbaListings,
  ) {
    items {
      _id
      batch_id
      inventory_id
      inventory {
        _id
        active
        msku
        fnsku
        quantity
        fba
        in_stock
        inbound
        transfer
        price
        payout
        misc
        product_id
        marketplace
        product {
          _id
          asin
          parent
          title
          image
          misc
          rank
          upc
          group
          marketplace
          expiration_required
          product_type
        }
        condition_id
        condition
        tax_code_id
        notes
        tags { _id name color url icon }
        prep_instructions {PrepOwner PrepInstruction}
        prep_details { prepCategory prepTypes allOwnersConstraint prepOwnerConstraint labelOwnerConstraint }
        storage_type
        listings_issues { code message severity attributeNames categories }
        listings_issues_updated
        listings_item { fulfillmentAvailability submitted attributes dimensionsSubmitted }
        listings_status
        update_listings_at
        update_listings_issues
        report_id
      }
      quantity
      unshipped
      quantity_in_case
      damaged
      tags { _id name color }
      errors
      buylist {
        _id
        purchased
        quantity
        cost
        expires
        source
        created_by_name
        misc
        origin
      }
      misc
      prep_instructions { PrepOwner PrepInstruction }
      prep_owner
      label_owner
      lot_code
      packing_group_id
      updated
    }
    invalid
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "invalid": [
    ]
}

Update BatchItem

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation UpdateBatchItem(
  $batch_item_id: ID!,
  $add_quantity: Int,
  $set_quantity: Int,
  $quantity_in_case: Int,
  $tags: [TagInput],
  $deleted: Boolean,
  $buylist: [BuylistInput],
  $inventory: InventoryInput,
  $prep_owner: String,
  $label_owner: String,
  $restore_buylist: Boolean,
  $lot_code: String,
) {
  updateBatchItem(
    batch_item_id: $batch_item_id,
    add_quantity: $add_quantity,
    set_quantity: $set_quantity,
    quantity_in_case: $quantity_in_case,
    deleted: $deleted,
    tags: $tags,
    buylist: $buylist,
    inventory: $inventory,
    prep_owner: $prep_owner,
    label_owner: $label_owner,
    restore_buylist: $restore_buylist,
    lot_code: $lot_code,
  ) {
    _id
    batch_id
    inventory_id
    inventory {
      _id
      active
      msku
      fnsku
      quantity
      fba
      in_stock
      inbound
      transfer
      price
      payout
      misc
      product_id
      marketplace
      product {
        _id
        asin
        parent
        title
        image
        misc
        rank
        upc
        group
        marketplace
        expiration_required
        product_type
      }
      condition_id
      condition
      tax_code_id
      notes
      tags { _id name color url icon }
      prep_instructions {PrepOwner PrepInstruction}
      prep_details { prepCategory prepTypes allOwnersConstraint prepOwnerConstraint labelOwnerConstraint }
      storage_type
      listings_issues { code message severity attributeNames categories }
      listings_issues_updated
      listings_item { fulfillmentAvailability submitted attributes dimensionsSubmitted }
      listings_status
      update_listings_at
      update_listings_issues
      report_id
    }
    quantity
    unshipped
    quantity_in_case
    damaged
    tags { _id name color }
    errors
    buylist {
      _id
      purchased
      quantity
      cost
      expires
      source
      created_by_name
      misc
      origin
    }
    misc
    prep_instructions { PrepOwner PrepInstruction }
    prep_owner
    label_owner
    lot_code
    packing_group_id
    updated
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Import PurchaseOrderItems

Authorizations:
bearer_auth
Request Body schema: application/json
query
string
mutation ImportPurchaseOrderItems(
  $batch_id: ID!,
  $items: [ImportPurchaseOrderItemInput!]!,
  $ShipToCountryCode: String,
  $send_prep_instructions: Boolean,
  $shipment_per_sku: Boolean
) {
  importPurchaseOrderItems(
    batch_id: $batch_id
    items: $items
    ShipToCountryCode: $ShipToCountryCode
    send_prep_instructions: $send_prep_instructions
    shipment_per_sku: $shipment_per_sku
  ) {
    _id
    batch_id
    inventory_id
    inventory {
      _id
      active
      msku
      fnsku
      quantity
      fba
      in_stock
      inbound
      transfer
      price
      payout
      misc
      product_id
      marketplace
      product {
        _id
        asin
        parent
        title
        image
        misc
        rank
        upc
        group
        marketplace
        expiration_required
        mapping {
          _id
          upc
          name
          products {
            _id
            quantity
            product {
              _id
              asin
            }
          }
        }
      }
      condition_id
      condition
      tax_code_id
      notes
      tags {
        _id
        name
        color
        url
      }
      prep_instructions {
        PrepOwner
        PrepInstruction
      }
      storage_type
      listings_issues {
        message
      }
      listings_issues_updated
      report_id
      must_send_feed
      active
      product_feed_batch_id
      product_feed_updated
      product_feed_status
      product_feed_errors
      inventory_feed_batch_id
      inventory_feed_updated
      inventory_feed_status
      inventory_feed_errors
      dimensions_feed_batch_id
      dimensions_feed_updated
      dimensions_feed_status
      dimensions_feed_errors
    }
    quantity
    quantity_in_case
    damaged
    purchase_order_batch_items {
      _id
      purchase_order_id
      purchase_order_name
      purchase_order_item_id
      quantity
    }
    deleted
    tags {
      _id
      name
      color
    }
    errors
    buylist {
      _id
      purchased
      quantity
      cost
      expires
      source
      created_by_name
      misc
      origin
    }
    shipments {
      id
      fcid
      prep
      quantity
      cp
    }
    misc
    prep_instructions {
      PrepOwner
      PrepInstruction
    }
    plans {
      plans {
        id
        fcid
        prep
        quantity
        requestId
        prep_instructions {
          PrepOwner
          PrepInstruction
        }
      }
      errors
      planning
    }
    plans_updated
    working_shipments {
      id
      fcid
      prep
      quantity
      cp
    }
    can_ship
    product_feed
    inventory_feed
    dimensions_feed
  }
}
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get PackHistory

Get PackHistory

Authorizations:
basic_auth
query Parameters
start
string
Example: start=2025-01-01

Get items packed after this timestamp

end
string
Example: end=2025-02-01

Get items packed before this timestamp

created-by
string
Example: created-by=2f16c5b2-97d3-4238-8b89-22851363bf27

Optional comma-separated list of user ids to restrict to

shipment
string
Example: shipment=FBA18V17NFFD

Optional comma-separated list of shipment ids to restrict to

header Parameters
X-Requested-With
required
string
Example: XMLHttpRequest

Must be XMLHttpRequest

Responses

Response samples

Content type
application/json
[
  • {
    }
]

WFS Shipment

Insert a Box

Insert a Box

Authorizations:
bearer_auth
Request Body schema: application/json
shipment_id
string

The shipment to create the box in

v1_batch_id
integer

The v1 batch to create the box in

v2_batch_id
integer <int64>

The v2 batch to create the box in

pallet_id
integer

Move the box to a pallet

quantity
integer

How many copies of this box there are

tracking_id
string

The tracking id

inbound_plan_id
required
string

The id of the inbound plan this box belongs to

packing_option_id
required
string

The id of the packing option this box belongs to

packing_group_id
string

The id of the packing group this box belongs to

length
integer

The length of the box in unit_of_measurement * 100

width
integer

The width of the box in unit_of_measurement * 100

height
integer

The height of the box in unit_of_measurement * 100

unit_of_measurement
string

CM | IN

weight
integer

The weight of the box in unit_of_weight * 100

unit_of_weight
string

KG | LB

Responses

Request samples

Content type
application/json
{
  • "shipment_id": "string",
  • "v1_batch_id": 0,
  • "v2_batch_id": 0,
  • "pallet_id": 0,
  • "quantity": 0,
  • "tracking_id": "string",
  • "inbound_plan_id": "string",
  • "packing_option_id": "string",
  • "packing_group_id": "string",
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "unit_of_measurement": "string",
  • "weight": 0,
  • "unit_of_weight": "string"
}

Response samples

Content type
application/json
{
  • "box": {
    }
}

Delete a Box

Delete a Box

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to delete

Responses

Response samples

Content type
application/json
{
  • "box": {
    }
}

Get a Box

Get a Box

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to get

Responses

Response samples

Content type
application/json
{
  • "box": {
    }
}

Delete Box

Update Box

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to update

Request Body schema: application/json
pallet_id
integer

Move the box to a pallet

quantity
integer

How many copies of this box there are

tracking_id
string

The tracking id

inbound_plan_id
required
string

The id of the inbound plan this box belongs to

packing_option_id
required
string

The id of the packing option this box belongs to

packing_group_id
string

The id of the packing group this box belongs to

length
integer

The length of the box in unit_of_measurement * 100

width
integer

The width of the box in unit_of_measurement * 100

height
integer

The height of the box in unit_of_measurement * 100

unit_of_measurement
string

CM | IN

weight
integer

The weight of the box in unit_of_weight * 100

unit_of_weight
string

KG | LB

Responses

Request samples

Content type
application/json
{
  • "pallet_id": 0,
  • "quantity": 0,
  • "tracking_id": "string",
  • "inbound_plan_id": "string",
  • "packing_option_id": "string",
  • "packing_group_id": "string",
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "unit_of_measurement": "string",
  • "weight": 0,
  • "unit_of_weight": "string"
}

Response samples

Content type
application/json
{
  • "box": {
    }
}

List BoxItems

List BoxItems

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to get

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Responses

Response samples

Content type
application/json
{
  • "box_items": [
    ],
  • "total_rows": 0
}

Insert BoxItem

Insert BoxItem

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box to get

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Request Body schema: application/json
sku
required
string
external_id
required
string
expiration
string
fnsku
string
label_owner
string
manufacturing_lot_code
string
object
prep_owner
string
quantity
integer
packing_group_id
string

Responses

Request samples

Content type
application/json
{
  • "sku": "string",
  • "external_id": "string",
  • "expiration": "string",
  • "fnsku": "string",
  • "label_owner": "string",
  • "manufacturing_lot_code": "string",
  • "prep_instructions": {
    },
  • "prep_owner": "string",
  • "quantity": 0,
  • "packing_group_id": "string"
}

Response samples

Content type
application/json
{
  • "box_item": {
    }
}

Delete BoxItem

Delete BoxItem

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box in which the item to delete resides

sku
required
string

The SKU of the box item to delete

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Responses

Response samples

Content type
application/json
{
  • "box_item": {
    }
}

Update BoxItem

Update BoxItem

Authorizations:
bearer_auth
path Parameters
box_id
required
string

The id of the box in which the item to update resides

sku
required
string

The SKU of the box item to update

query Parameters
box_created
required
string

The timestamp the box with ID box_id was created

Request Body schema: application/json
expiration
string
fnsku
string
label_owner
string
manufacturing_lot_code
string
object
prep_owner
string
quantity
integer
packing_group_id
string

Responses

Request samples

Content type
application/json
{
  • "expiration": "string",
  • "fnsku": "string",
  • "label_owner": "string",
  • "manufacturing_lot_code": "string",
  • "prep_instructions": {
    },
  • "prep_owner": "string",
  • "quantity": 0,
  • "packing_group_id": "string"
}

Response samples

Content type
application/json
{
  • "box_item": {
    }
}

List Batches

Authorizations:
bearer_auth
query Parameters
batch_id
string

Select a specific batch by ID

archived
boolean

Filter by archived status (true/false)

offset
integer

Pagination offset

limit
integer

Pagination limit

inbound_order_id
string

Filter by inbound order ID (prefix match)

ship_from_id
string

Filter by ship from ID

Responses

Response samples

Content type
application/json
{
  • "batches": [
    ],
  • "total_rows": 0
}

Insert Batches

Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "batches": [
    ]
}

Response samples

Content type
application/json
{
  • "batches": [
    ],
  • "errors": [
    ]
}

Get Walmart Batch by ID

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

Select a specific batch by ID

query Parameters
archived
boolean

Filter by archived status (true/false)

offset
integer

Pagination offset

limit
integer

Pagination limit

inbound_order_id
string

Filter by inbound order ID (prefix match)

ship_from_id
string

Filter by ship from ID

Responses

Response samples

Content type
application/json
{
  • "batch": {
    }
}

Update Batches

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

Comma separated list of batch ids to update

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "batch": {
    }
}

Response samples

Content type
application/json
{
  • "batches": [
    ],
  • "errors": [
    ]
}

Delete Batches

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

A comma separated list of batch IDs

Responses

Response samples

Content type
application/json
{
  • "batches": [
    ],
  • "errors": [
    ]
}

List BatchItems

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

ID of the batch

Responses

Response samples

Content type
application/json
{
  • "total_rows": 0,
  • "batch_items": [
    ]
}

Insert BatchItems

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

ID of the batch

Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "batch_items": [
    ]
}

Response samples

Content type
application/json
{
  • "batch_items": [
    ]
}

Update BatchItems

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

ID of the batch

Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "batch_items": [
    ]
}

Response samples

Content type
application/json
{
  • "batch_items": [
    ],
  • "errors": [
    ]
}

Update BatchItem

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

ID of the batch

batch_item_id
required
string

ID of the batch item

Request Body schema: application/json
required
sku
string
quantity
integer
quantity_in_case
integer
object

Responses

Request samples

Content type
application/json
{
  • "sku": "string",
  • "quantity": 0,
  • "quantity_in_case": 0,
  • "item_prep": {
    }
}

Response samples

Content type
application/json
{
  • "batch_item": {
    }
}

Delete BatchItems

Authorizations:
bearer_auth
path Parameters
batch_id
required
string

ID of the batch

batch_item_id
required
string

Comma separated list of batch item IDs

Responses

Response samples

Content type
application/json
{
  • "batch_item": {
    }
}

Get InboundShipments

Wrapper around Walmart's Get Shipments API

Authorizations:
bearer_auth
query Parameters
offset
string
Default: "0"
limit
string
Default: "10"
inboundOrderId
string
shipmentId
string
status
string
fromCreateDate
string <date-time>
toCreateDate
string <date-time>
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "headers": {
    },
  • "payload": [
    ]
}

Create InboundShipment

Wrapper around Walmart's Create Inbound Shipment API

Authorizations:
bearer_auth
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
inboundOrderId
required
string
object
required
object
required
Array of objects (wm.OrderItem)

length between 1 and 5000

Responses

Request samples

Content type
application/json
{
  • "inboundOrderId": "string",
  • "inboundServices": {
    },
  • "returnAddress": {
    },
  • "orderItems": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "payload": [
    ]
}

Fetch InboundPreview

Wrapper around Walmart's Fetch Inbound Preview API

Authorizations:
bearer_auth
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
object
object

Responses

Request samples

Content type
application/json
{
  • "header": {
    },
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "payload": [
    ]
}

Update Shipment Quantities

Wrapper around Walmart's Update Shipment Quantities API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string

ID of the shipment to update

header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
inboundOrderId
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "inboundOrderId": "string",
  • "orderItems": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "payload": { },
  • "errors": [
    ]
}

Update Walmart Shipment Tracking Details

Wrapper around Walmart's Update Shipment Tracking API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string

ID of the shipment to update

header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
carrierName
string
trackingInfo
Array of strings

Responses

Request samples

Content type
application/json
{
  • "carrierName": "string",
  • "trackingInfo": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "payload": { },
  • "errors": [
    ]
}

Create Carrier RateQuote

Wrapper around Walmart's Create Carrier Rate Quote API

Authorizations:
bearer_auth
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
shipmentId
required
string
shipmentSource
string
pickupFromDateTime
string
pickupToDateTime
string
deliveryFromDateTime
string
deliveryToDateTime
string
object
required
object
object
object
required
Array of objects (wm.ShipmentPackage)
mode
required
string (wm.Mode)
Enum: "PARCEL" "LTL" "FTL"
freightClass
string
declaredValue
integer
Array of objects

Responses

Request samples

Content type
application/json
{
  • "shipmentId": "string",
  • "shipmentSource": "string",
  • "pickupFromDateTime": "string",
  • "pickupToDateTime": "string",
  • "deliveryFromDateTime": "string",
  • "deliveryToDateTime": "string",
  • "customer": {
    },
  • "originLocation": {
    },
  • "destinationLocation": {
    },
  • "returnLocation": {
    },
  • "shipmentPackages": [
    ],
  • "mode": "PARCEL",
  • "freightClass": "string",
  • "declaredValue": 0,
  • "loadTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "shipmentId": "string",
  • "shipmentNumber": "string",
  • "rateQuotes": [
    ],
  • "errors": [
    ]
}

Get Carrier RateQuote

Wrapper around Walmart's Get Carrier Rate Quote API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string
mode
required
string (wm.Mode)
Enum: "PARCEL" "LTL" "FTL"
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "shipmentId": "string",
  • "quoteId": "string",
  • "estimatedDeliveryDateTime": "2019-08-24T14:15:22Z",
  • "quoteCreationDate": "2019-08-24T14:15:22Z",
  • "carrier": {
    },
  • "rateQuote": {
    },
  • "shipmentPackages": [
    ],
  • "originLocation": {
    },
  • "destinationLocation": {
    },
  • "returnLocation": {
    },
  • "errors": [
    ]
}

Cancel Carrier RateQutoe

Wrapper around Walmart's Cancel Carrier Rate Quote API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "header": { },
  • "payload": { },
  • "errors": [
    ]
}

Select Walmart Shipments from the database

Select Walmart shipments from the database

Authorizations:
bearer_auth
query Parameters
wm_shipment_id
string
inbound_order_id
string
source_address
string

Filter by ship from ID

offset
integer

Pagination offset

limit
integer

Pagination limit

Responses

Response samples

Content type
application/json
{
  • "total_rows": 0,
  • "wm_shipments": [
    ]
}

Select a single Walmart Shipment by Id

Select a single Walmart shipment by id

Authorizations:
bearer_auth
path Parameters
wm_shipment_id
required
string

Responses

Response samples

Content type
application/json
{
  • "wm_shipment": {
    }
}

Select Walmart Boxes from the database

Select Walmart boxes from the database

Authorizations:
bearer_auth
path Parameters
wm_shipment_id
required
string

Responses

Response samples

Content type
application/json
{
  • "total_rows": 0,
  • "boxes": [
    ]
}

Insert Walmart Boxes into our database

Insert Walmart boxes into our database

Authorizations:
bearer_auth
path Parameters
wm_shipment_id
required
string
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "boxes": {
    }
}

Response samples

Content type
application/json
{
  • "boxes": [
    ]
}

Update Walmart Boxes into our database

Update Walmart boxes into our database

Authorizations:
bearer_auth
path Parameters
wm_shipment_id
required
string
Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "boxes": {
    }
}

Response samples

Content type
application/json
{
  • "boxes": [
    ],
  • "errors": [
    ]
}

Select a single Walmart Box by Id

Select a single Walmart box by id

Authorizations:
bearer_auth
path Parameters
wm_shipment_id
required
string
wm_box_id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "box": {
    }
}

Delete one or more Walmart Boxes by Id

Delete one or more Walmart boxes by id

Authorizations:
bearer_auth
path Parameters
wm_shipment_id
required
string
wm_box_id
required
string

A comma separated list of box ids

Responses

Response samples

Content type
application/json
{
  • "boxes": [
    ]
}

Create InboundShipment Label

Wrapper around Walmart's Create Inbound Shipment label API

Authorizations:
bearer_auth
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
shipmentId
required
string
labelSize
string
Enum: "X4_6" "X4_3"
labelFormat
string
Enum: "PDF" "ZPL"
Array of objects

Responses

Request samples

Content type
application/json
{
  • "shipmentId": "string",
  • "labelSize": "X4_6",
  • "labelFormat": "PDF",
  • "loadTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Print Walmart Carrier Label

Wrapper around Walmart's Print Carrier Label API

Authorizations:
bearer_auth
path Parameters
shipmentId
required
string
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Request Body schema: application/json
required
shipDate
required
string <date-time>

Full timestamp with microsecond precision required

Responses

Request samples

Content type
application/json
{
  • "shipDate": "2025-08-22T00:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get InboundShipment Errors

Wrapper around Walmart's Get Inbound Shipment errors API

Authorizations:
bearer_auth
query Parameters
offset
string
Default: "0"
limit
string
Default: "10"
inboundOrderId
string
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "headers": {
    },
  • "payload": [
    ]
}

Get InboundShipment Items

Wrapper around Walmart's Get Inbound Shipment Items API

Authorizations:
bearer_auth
query Parameters
offset
string
Default: "0"
limit
string
Default: "10"
shipmentId
string
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "headers": {
    },
  • "payload": [
    ]
}

Cancel InboundShipment

Wrapper around Walmart's Cancel Inbound Shipment API

Authorizations:
bearer_auth
path Parameters
inboundOrderId
required
string
header Parameters
x-wm-access-token
required
string

A Walmart API access token

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "header": { },
  • "payload": { },
  • "errors": [
    ]
}

Account

Get a list of active users (parent and sub users)

Get a list of active users (parent and sub users)

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of Client Proxy Users

Get a list of client proxy users

Authorizations:
basic_auth
query Parameters
proxy
string
Example: proxy=proxy

The proxy indicator

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Prep Billing

Get all Prep Matrix Product mappings

Retrieve a list of prep_matrix_products with optional filters

Authorizations:
bearer_auth
query Parameters
prep_matrix_id
string

Filter by prep_matrix_id

prep_matrix_name
string

Filter by prep_matrix name

external_id
string

Filter by external ID

client_id
string

Filter by client ID

Responses

Response samples

Content type
application/json
{
  • "prep_matrix_products": [
    ],
  • "total_rows": 0
}

Create multiple Prep Matrix Product mappings

Insert one or more prep_matrix_product records

Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects (NewPrepMatrixProduct)

Responses

Request samples

Content type
application/json
{
  • "prep_matrix_products": [
    ]
}

Response samples

Content type
application/json
{
  • "prep_matrix_products": [
    ]
}

Get a specific Prep Matrix Product mapping by external_id

Retrieve a prep_matrix_product by its external_id

Authorizations:
bearer_auth
path Parameters
external_id
required
string

External ID of the prep_matrix_product

Responses

Response samples

Content type
application/json
{
  • "prep_matrix_product": {
    }
}

Update a Prep Matrix Product mapping by external_id

Update a prep_matrix_product by its external_id

Authorizations:
bearer_auth
path Parameters
external_id
required
string

A comma separated list of external IDs. Each matching item will be updated with the data in the request body

Request Body schema: application/json
required
prep_matrix_id
integer <int64>

Unique ID for the prep_matrix_name

prep_matrix_name
string

What preparations need to be made, eg 'Bubblewrap', 'Security + Label', etc.

deleted
null

null may be passed to un-delete a previously deleted prep_matrix_product

Responses

Request samples

Content type
application/json
{
  • "prep_matrix_id": 0,
  • "prep_matrix_name": "string",
  • "deleted": null
}

Response samples

Content type
application/json
{
  • "prep_matrix_products": [
    ]
}

Delete one or more Prep Matrix Product mapping by external_id

Delete one or more prep_matrix_product by external_id

Authorizations:
bearer_auth
path Parameters
external_id
required
string

Comma separated list of external IDs

Responses

Response samples

Content type
application/json
{
  • "prep_matrix_products": [
    ]
}

Get all Prep Matrices

Retrieve a list of prep_matrices with optional filters

Authorizations:
bearer_auth
query Parameters
prep_matrix_id
string

Filter by prep_matrix_id

prep_matrix_name
string

Filter by prep_matrix name

ad_hoc
boolean

Filter by ad_hoc

prep_matrix_category_ids
string

Comma separated list of category ids to filter by

prep_matrix_category_names
string

Comma separated list of category names to filter by. If a name has a comma in it, wrap it with quotes

client_ids
string
Example: client_ids=2f16c5b2-97d3-4238-8b89-22851363bf27,null

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.

Responses

Response samples

Content type
application/json
{
  • "prep_matrices": [
    ],
  • "total_rows": 0
}

Create multiple Prep Type matrices

Insert multiple prep_matrices

Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects (NewPrepMatrix)

Responses

Request samples

Content type
application/json
{
  • "prep_matrices": [
    ]
}

Response samples

Content type
application/json
{
  • "prep_matrices": [
    ]
}

Get all Prep Tiers

Retrieve a list of prep tiers

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "prep_tiers": [
    ],
  • "total_rows": 0
}

Create one or more prep tiers

Insert multiple prep_tiers

Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects (NewPrepTier)

Responses

Request samples

Content type
application/json
{
  • "prep_tiers": [
    ]
}

Response samples

Content type
application/json
{
  • "prep_tiers": [
    ]
}

Update one or more Prep Tiers

Update multiple prep tiers

Authorizations:
bearer_auth
path Parameters
prep_tier_ids
required
integer <int64>

Comma separated list of prep_tier ids to update

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "prep_tier": {
    }
}

Response samples

Content type
application/json
{
  • "prep_tiers": [
    ],
  • "total_rows": 0
}

Delete one or more prep tiers

Delete multiple prep_tiers

Authorizations:
bearer_auth
path Parameters
prep_tier_ids
required
integer <int64>

Comma separated list of prep_tier ids to update

Responses

Response samples

Content type
application/json
{
  • "prep_tiers": [
    ]
}

Get all prep matrix categories

Retrieve a list of prep_matrix_categories with optional filters

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "prep_matrix_categories": [
    ],
  • "total_rows": 0
}

Create one or more prep categories

Insert multiple prep_matrix_category records

Authorizations:
bearer_auth
Request Body schema: application/json
required
prep_matrix_category_names
Array of strings

Responses

Request samples

Content type
application/json
{
  • "prep_matrix_category_names": [
    ]
}

Response samples

Content type
application/json
{
  • "prep_matrix_categories": [
    ]
}

Update a prep matrix category name

Update a single prep_matrix_category by id

Authorizations:
bearer_auth
path Parameters
prep_matrix_category_id
required
integer <int64>

ID of the prep_matrix_category to update

Request Body schema: application/json
required
prep_matrix_category_name
string

The new prep matrix category name

Responses

Request samples

Content type
application/json
{
  • "prep_matrix_category_name": "string"
}

Response samples

Content type
application/json
{
  • "prep_matrix_category": {
    }
}

Delete one or more prep categories

Delete multiple prep_matrix_category records

Authorizations:
bearer_auth
path Parameters
prep_matrix_category_id
required
string

Comma separated list of the prep_matrix_category ids to delete

Responses

Response samples

Content type
application/json
{
  • "prep_matrix_categories": [
    ]
}

Get the billing report for a given time period

Get the billing report for a given time period

Authorizations:
bearer_auth
query Parameters
start
required
string <date-time>

Start date in ISO 8601 format

end
string <date-time>

Optional end date in ISO 8601 format

client_ids
string <uuid>

A comma separated list of client user ids.

detail
string
Value: "1"

Pass this parameter to generate a detailed report. Only when requesting spreadsheet output.

header Parameters
Accept
string
Enum: "application/json" "text/csv" "application/vnd.ms-excel"

Specify text/csv or application/vnd.ms-excel to generate CSV or XLSX formats respectively.

Responses

Response samples

Content type
[
  • {
    }
]

Get the billing report for a given time period

Get the billing report for a given time period

Authorizations:
bearer_auth
header Parameters
Accept
string
Enum: "application/json" "text/csv" "application/vnd.ms-excel"

Specify text/csv or application/vnd.ms-excel to generate CSV or XLSX formats respectively.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "prep_matrix": {
    }
}

Response samples

Content type
[
  • {
    }
]

Get shipment-level ad hoc charges

Get shipment-level ad hoc charges

Authorizations:
bearer_auth
query Parameters
client_ids
string <uuid>

A comma separated list of client user ids.

shipment_ids
string

A comma separated list of shipment confirmation ids.

prep_matrix_ids
integer <int64>

A comma separated list of prep matrix ids.

prep_matrix_names
string

A comma separated list of prep matrix names.

Responses

Response samples

Content type
application/json
{
  • "total_rows": 0,
  • "shipment_prep_matrices": [
    ]
}

Get shipment-level ad hoc charges

Get shipment-level ad hoc charges

Authorizations:
bearer_auth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "prep_matrix": {
    }
}

Response samples

Content type
application/json
{
  • "total_rows": 0,
  • "shipment_prep_matrices": [
    ]
}

Add one or more shipment-level ad hoc charges

Add one or more shipment-level ad hoc charges

Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "shipment_prep_matrices": [
    ]
}

Response samples

Content type
application/json
{
  • "shipment_prep_matrices": [
    ],
  • "errors": [
    ]
}

Update or delete one or more shipment-level ad hoc charges

Update or delete one or more shipment-level ad hoc charges

Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "shipment_prep_matrices": [
    ]
}

Response samples

Content type
application/json
{
  • "shipment_prep_matrices": [
    ],
  • "errors": [
    ]
}

Get all Prep Matrix Tiers

Prep matrix tiers are mapping of prep types to tiers along with the price and currency code

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "prep_matrix_tiers": [
    ],
  • "total_rows": 0
}

Create one or more prep matrix tiers

Insert multiple prep_matrix_tiers

Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects (NewPrepMatrixTier)

Responses

Request samples

Content type
application/json
{
  • "prep_matrix_tiers": [
    ]
}

Response samples

Content type
application/json
{
  • "prep_matrix_tiers": [
    ]
}

Update one or more prep matrix tiers

Update multiple prep_matrix_tiers

Authorizations:
bearer_auth
Request Body schema: application/json
required
Array of objects (UpdatePrepMatrixTier)

Responses

Request samples

Content type
application/json
{
  • "prep_matrix_tiers": [
    ]
}

Response samples

Content type
application/json
{
  • "prep_matrix_tiers": [
    ]
}

Get all Prep Client Tiers

Retrieve a list of prep client tiers with optional filters

Authorizations:
bearer_auth
query Parameters
client_ids
string <uuid>

A comma separated list of client user ids.

prep_tier_ids
string

A comma separated list of prep tier ids.

Responses

Response samples

Content type
application/json
{
  • "prep_client_tiers": [
    ],
  • "total_rows": 0
}

Create one or more prep client tiers

Insert multiple prep_client_tiers

Authorizations:
bearer_auth
path Parameters
client_ids
required
string

Comma separated list of client ids

Request Body schema: application/json
required
prep_tier_id
integer <int64>

Either this or prep_tier_name is required

prep_tier_name
string

Either this or prep_tier_id is required

Responses

Request samples

Content type
application/json
{
  • "prep_tier_id": 0,
  • "prep_tier_name": "string"
}

Response samples

Content type
application/json
{
  • "prep_client_tiers": [
    ]
}

Update one or more prep client tiers

Update multiple prep_client_tiers

Authorizations:
bearer_auth
path Parameters
client_ids
required
string

Comma separated list of client ids

Request Body schema: application/json
required
prep_tier_id
integer <int64>

Either this or prep_tier_name is required

prep_tier_name
string

Either this or prep_tier_id is required

Responses

Request samples

Content type
application/json
{
  • "prep_tier_id": 0,
  • "prep_tier_name": "string"
}

Response samples

Content type
application/json
{
  • "prep_client_tiers": [
    ]
}

Delete one or more prep client tiers

Delete multiple prep_client_tiers

Authorizations:
bearer_auth
path Parameters
client_ids
required
string

Comma separated list of client ids

Responses

Response samples

Content type
application/json
{
  • "prep_client_tiers": [
    ]
}

Get a specific Prep Type Matrix by ID

Retrieve a prep_matrix by its ID

Authorizations:
bearer_auth
path Parameters
prep_matrix_id
required
integer

ID of the prep_matrix

Responses

Response samples

Content type
application/json
{
  • "prep_matrix": {
    }
}

Update one or more Prep Type Matrices by ID

Update one or more prep_matrices by its ID

Authorizations:
bearer_auth
path Parameters
prep_matrix_id
required
string

Comma separated list of Prep Type Matrix IDs

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "prep_matrix": {
    }
}

Response samples

Content type
application/json
{
  • "prep_matrices": [
    ]
}

Delete one or more Prep Type Matrices by ID

Delete one or more prep_matrices by ID

Authorizations:
bearer_auth
path Parameters
prep_matrix_ids
required
string

Comma seprated list of prep_matrix IDs

Responses

Response samples

Content type
application/json
{
  • "prep_matrices": [
    ]
}