Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Wish

Wish Orders API

The Orders API from Wish — 9 operation(s) for orders.

Documentation Provider Profile APIs.io OpenAPI GitHub

Wish Orders API is one of 21 APIs that Wish publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orders. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 10 operations across 9 paths, and defines 62 schemas. It is described by OpenAPI 3.0.0, at version 3.0.65.

Requests are made against a single base URL, https://merchant.wish.com.

10 operations 9 paths 62 schemas 5 GET1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.65
Base URL
https://merchant.wish.com/api/v3
Authentication
OpenID Connect, OAuth 2.0
Contact
partner-api@wish.com
Resource Areas
1

Authentication & Security 2

Wish Orders API declares 2 security schemes for authenticating requests. It supports OpenID Connect (OpenID) discovered at https://merchant.wish.com/oidc/.well-known/openid-configuration. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 37 scopes. By default, every request must be authenticated.

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 5 GET, 1 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Orders 10
GET
/api/v3/orders/shipping_carriers
Get accepted shipping carriers
GetShippingCarriers 2 params → 200
POST
/api/v3/orders/bulk_get
Batch download orders
downloadOrders 8 params → 200400
GET
/api/v3/orders/bulk_get/{id}
Get batch download job status
getOrderDownloadJob 1 param → 200400
PUT
/api/v3/orders/{id}/tracking
Ship or update tracking
ShipOrder 1 param body → 200
GET
/api/v3/orders/{id}/refund_reasons
Get valid refund reasons
GetValidRefundReasons 1 param → 200
PUT
/api/v3/orders/{id}
Update an LTL order
UpdateOrder 1 param body → 200
GET
/api/v3/orders/{id}
Get an order
GetOrder 1 param → 200
PUT
/api/v3/orders/{id}/address
Modify shipping address
ModifyAddress 1 param body → 200
PUT
/api/v3/orders/{id}/refund
Refund/Cancel an order
RefundOrder 1 param body → 200
GET
/api/v3/orders
List orders
GetMultipleOrders 8 params → 200

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are Order (20 properties), EUVATCustomsDeclaration (15 properties), GeneralPaymentDetails (10 properties), ShippingAddress (10 properties). Each schema is shown below with its type and property counts.

FulfillmentEventType
string
The type of fulfillment milestone
EORI
object
Information for the EORI
2 properties
Price
object
2 properties 2 required
RevShareRegion
string
The region used to determine revshare
SpecialProgramsInfo
object
Special program info
2 properties
APIError
object
2 properties 2 required
TrackingInfo
object
Tracking information
4 properties
WarehouseInformation
object
Warehouse information
4 properties
UpdateOrder
object
3 properties
OrderType
string
Order type
VATAdditionalMaterial
string
VAT additional material
UpdateTracking
object
4 properties 3 required
PhoneNumber
object
2 properties 1 required
AddressWithPhone
VAT
object
VAT info
6 properties
State
string
Returns the order's current state. Possible values are: 1. APPROVED: Order is ready to be shipped. 2. SHIPPED: Order has been shipped. 3. REFUNDED: Order has b…
ShippingProvider
object
1 property
OrderTax
object
Order tax requirements
4 properties
ProductInfo
object
Product info
8 properties
FulfillmentRequirements
object
Order's general requirements.
2 properties
RefundReason
string
The reason for the refund
Address
object
8 properties 5 required
EUVATCustomsDeclarationProduct
object
Product information for EU VAT customs, including name, imageurl, weight, and etc
6 properties
Weight
object
2 properties 2 required
OrderDownloadJob
object
2 properties
RefundOrder
object
2 properties 1 required
Order
object
20 properties
VOEC
object
Information for the VOEC
2 properties
VATAmount
object
Currently only for UK-bound orders; This field breaks down VAT quantities for this order.
3 properties
RefundSource
string
The source of the refund.
RequiredVATNumber
object
Information for the required VAT number
3 properties
Orders
array
GeneralPaymentDetails
object
Relevant information regarding an order's payments
10 properties
ShippingAddress
object
10 properties 5 required
TaxEntity
string
Tax entity type
Money
object
2 properties 2 required
ProcessingSource
string
Reflects asynchronous actions currently being applied to order from Ship or update tracking, Refund/Cancel an order, and Modify shipping address endpoints. Pai…
Carriers
array
List of valid shipping carriers
ShippingReimbursementStatus
string
Shipping reimbursement status
ShippingReimbursement
object
Shipping reimbursement
2 properties
OrderPayment
object
Returns relevant information regarding an order's payments
4 properties
MerchantWarehouseType
string
Merchant warehouse type
FBWFee
object
FBW fee
3 properties
EUVATCustomsDeclaration
object
If the order is subject to EU VAT and is valued at lower than 150 EUR, this field will return all required information for customs declaration.
15 properties
V3GenericReportStatus
object
A generic report status object used when an endpoint wants to return the status of their downloadable file
8 properties
TaxItem
object
4 properties
OrderTypeFilter
string
Order type to filter by
CarrierSubsidy
object
Carrier subsidies
2 properties
OrderShippingDetail
Order shipping details
RevShareDetails
object
Relevant information regarding an order's revenue share
7 properties
CustomerIdentityNumberType
string
Orders entering into certain countries require an individual taxpayer ID or customs information. This field indicates the type of ID provided. Possible values…
RemitType
string
Displays who should remit taxes for this order. 1. WISHREMIT: Wish will remit. 2. MERCHANTREMIT: Merchant will remit. 3. TBDREMIT: UK-specific; this will resol…
PlatformEntity
string
Indicates if the platform (Wish) is the reseller or the owner of the product
RefundsInfo
object
Refund info
6 properties
CustomerPaidPricesDetail
object
Customer paid price of an order after various adjustments
5 properties
FBWFeeType
string
FBW Fee type
VATPayer
object
Information about the payer of VAT
4 properties
ProcessingStatus
string
Reflects the progress of the action shown in processingsource. The attribute will be empty until V3 PUT endpoints are released later this year.
FulfillmentEvent
object
Fulfillment event
2 properties
OrderAddress
RefundReasons
array
List of valid refund reasons
LotInfo
object
FBW lot info
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wish-orders-api-openapi.yml Raw ↑

Other APIs Wish publishes across the network.

Wish Brands API
AE Profile APIs.io
Wish Bulk Products API
AE Profile APIs.io
Wish Currencies API
AE Profile APIs.io
Wish EU Product Compliance API
AE Profile APIs.io
Wish France EPR Compliance API
AE Profile APIs.io
Wish Germany EPR Compliance API
AE Profile APIs.io
Wish Merchant API
AE Profile APIs.io
Wish OAuth API
AE Profile APIs.io
Wish Payments API
AE Profile APIs.io
Wish Penalties API
AE Profile APIs.io
Wish ProductBoost API
AE Profile APIs.io
Wish Products API
AE Profile APIs.io
#Orders
← Back to W APIs
API Details
ID
wish:wish-orders-api
Base URL
https://merchant.wish.com/api/v3
Docs
https://merchant.wish.com/documentation/api/v3/reference
Provider
Wish
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network