货运发票API v0参考

亚马逊SPAPI

# 概述

销售伙伴发货发票的API可以帮助你在巴西市场上以编程方式检索销售伙伴的亚马逊履约服务(FBA)订单的发货发票信息.

# Version information

版本 : v0

# Operations

getShipmentDetails
submitInvoice
getInvoiceStatus
<a name="paths">

# 路径

<a name="getshipmentdetails">

# getShipmentDetails

GET /fba/outbound/brazil/v0/shipments/{shipmentId}

# Description

返回为指定货件开具发票所需的货件详情.

使用计划:

计划类型 速率(每秒请求数) 突发
Default 1.133 25
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path shipmentId
required
the identifier for the shipment. Get this value from the FBAOutboundShipmentStatus notification. For information about subscribing to notifications, see the [Notifications API Use Case Guide](doc notifications-api-use-case-guide). string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
GetShipmentDetailsResponse
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentDetailsResponse
401 请求的授权头格式不正确或不包含有效的标记.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetShipmentDetailsResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : Unique request reference identifier.
GetShipmentDetailsResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetShipmentDetailsResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetShipmentDetailsResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetShipmentDetailsResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetShipmentDetailsResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetShipmentDetailsResponse

<a name="submitinvoice">

# submitInvoice

POST /fba/outbound/brazil/v0/shipments/{shipmentId}/invoice

# Description

为指定的货件提交一份货件发票文件.

使用计划:

计划类型 速率(每秒的请求) 突发
Default 1.133 25
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path shipmentId
required
货件的识别码. string
Body body
required
提交发票操作的请求模式. SubmitInvoiceRequest

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
SubmitInvoiceResponse
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
SubmitInvoiceResponse
401 请求的授权头格式不正确或不包含有效的标记.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
SubmitInvoiceResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
SubmitInvoiceResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
SubmitInvoiceResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
SubmitInvoiceResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
SubmitInvoiceResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
SubmitInvoiceResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
SubmitInvoiceResponse

<a name="getinvoicestatus">

# getInvoiceStatus

GET /fba/outbound/brazil/v0/shipments/{shipmentId}/invoice/status

# Description

返回您指定的货件的发票状态.

使用计划:

计划类型 速率(每秒的请求) 突发
Default 1.133 25
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.一些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path shipmentId
required
货件的货件标识符. string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
GetInvoiceStatusResponse
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
GetInvoiceStatusResponse
401 请求的授权头格式不正确或不包含有效的标记.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetInvoiceStatusResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetInvoiceStatusResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference identifier.
GetInvoiceStatusResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetInvoiceStatusResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetInvoiceStatusResponse
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetInvoiceStatusResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetInvoiceStatusResponse

<a name="definitions">

# Definitions

<a name="getshipmentdetailsresponse">

# GetShipmentDetailsResponse

getShipmentDetails操作的响应模式.

Name Description Schema
payload
optional
getShipmentDetails操作的有效载荷 ShipmentDetail
errors
optional
A list of error responses return when a request is unsuccessful. ErrorList

<a name="shipmentdetail">

# ShipmentDetail

销售伙伴开具货物发票所需的信息.

Name Description Schema
WarehouseId
optional
亚马逊-定义的仓库的标识符. string
AmazonOrderId
optional
The Amazon-defined identifier for the order. string
AmazonShipmentId
optional
亚马逊-定义的货物标识符. string
PurchaseDate
optional
创建订单的日期和时间. string (date-time)
ShippingAddress
optional
货物的运输地址详情. Address
PaymentMethodDetails
optional
The list of payment method details. PaymentMethodDetailItemList
MarketplaceId
optional
下订单的市场的标识符. string
SellerId
optional
卖家识别码. string
BuyerName
optional
买方的名称. string
*BuyerCounty
optional
买方的县. string
BuyerTaxInfo
optional
关于买方的税收信息. BuyerTaxInfo
MarketplaceTaxInfo
optional
Tax information about the marketplace. MarketplaceTaxInfo
SellerDisplayName
optional
在市场上注册的卖方的友好名称. string
发货项目
可选
发货项目列表. 发货项目

<a name="地址">

# Address

货件的详细收货地址.

Name Description Schema
Name
optional
The name. string
AddressLine1
optional
街道地址. string
AddressLine2
optional
额外的街道地址信息,如果需要的话. string
AddressLine3
optional
额外的街道地址信息,如果需要的话. string
City
optional
The city. string
County
optional
The county. string
District
optional
The district. string
州或地区
可选择
州或地区. string
PostalCode
optional
邮政编码. string
CountryCode
optional
国家代码. string
电话
可选择
电话号码. string
AddressType
optional
The shipping address type. AddressTypeEnum

<a name="addresstypeenum">

# AddressTypeEnum

发货地址类型.

类型 : 枚举

Value Description
住宅 地址类型为住宅.
商业 地址类型为商业.

<a name="paymentmethoddetailitemlist">

# PaymentMethodDetailItemList

支付方式详情列表.

类型 < string > 数组

<a name="buyertaxinfo">

# BuyerTaxInfo

关于买方的税务信息.

Name Description Schema
公司法律名称
可选
公司的法律名称. 字符串
TaxingRegion
optional
征税的国家或地区. string
TaxClassifications
optional
The list of tax classifications. TaxClassificationList

<a name="marketplacetaxinfo">

# MarketplaceTaxInfo

关于市场的税务信息.

Name Description Schema
公司法律名称
可选
公司的法律名称. 字符串
TaxingRegion
optional
征税的国家或地区. string
TaxClassifications
optional
The list of tax classifications. TaxClassificationList

<a name="taxclassificationlist">

# TaxClassificationList

税收分类列表.

类型< TaxClassification >数组

<a name="taxclassification">

# TaxClassification

该实体的税收分类.

Name Description Schema
名称
可选
税收的类型. 字符串

可选择
实体的税务识别码. string

<a name="shipmentitems">

# ShipmentItems

一个货件的列表.

类型 < ShipmentItem > 数组

<a name="shipmentitem">

# ShipmentItem

卖方开具货件发票所需的货件信息.

Name Description Schema
ASIN
optional
亚马逊标准识别码(ASIN)的物品. string
SellerSKU
optional
该商品的卖家SKU. string
OrderItemId
optional
亚马逊-定义的订单项目的标识符. string
Title
optional
物品的名称. string
订购数量
可选
订购的物品数量. number
ItemPrice
optional
物品的销售价格乘以订购数量.注意,ItemPrice不包括ShippingPrice和GiftWrapPrice. Money
ShippingPrice
optional
项目的运输价格. Money
GiftWrapPrice
optional
该物品的礼品包装价格. Money
运费折扣
可选择
运费价格的折扣. Money
PromotionDiscount
optional
报价中所有促销折扣的总额. Money
序列号
选项
序列号列表. SerialNumbersList

<a name="money">

# Money

货币类型和金额.

Name Description Schema
CurrencyCode
optional
三位数的ISO 4217格式的货币代码. string
金额
可选择
货币金额. string

<a name="serialnumberslist">

# SerialNumbersList

序列号的列表.

类型 < string > 数组

<a name="errorlist">

# ErrorList

当请求不成功时,返回的错误响应列表.

类型 < Error > 数组

<a name="error">

# Error

当请求不成功时返回的一个错误响应.

Name Description Schema
code
required
一个错误代码,用于识别所发生的错误类型. string
message
required
一个描述错误情况的信息. string
details
optional
可以帮助呼叫者理解或解决这个问题的额外细节. string

<a name="submitinvoicerequest">

# SubmitInvoiceRequest

提交发票操作的请求模式.

Name Description Schema
InvoiceContent
required
Shipment invoice document content. Blob
MarketplaceId
optional
An Amazon marketplace identifier. string
ContentMD5Value
required
MD5 sum for validating the invoice data. For more information about calculating this value, see Working with Content-MD5 Checksums (opens new window). string

<a name="blob">

# Blob

发货发票文件内容.

Type : string (byte)

<a name="submitinvoiceresponse">

# SubmitInvoiceResponse

提交发票操作的响应模式.

Name Description Schema
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<a name="shipmentinvoicestatusinfo">

# ShipmentInvoiceStatusInfo

货运发票状态信息.

Name Description Schema
AmazonShipmentId
optional
The Amazon-defined shipment identifier. string
InvoiceStatus
optional
The shipment invoice status. ShipmentInvoiceStatus

<a name="shipmentinvoicestatus">

# ShipmentInvoiceStatus

货运发票状态.

类型 : 枚举

Value Description
处理中 发票验证过程正在进行中.
接受 发票验证过程成功,发票被成功录入.
Errored 发票验证过程失败.
NotFound 请求的发票没有找到.

<a name="shipmentinvoicestatusresponse">

# ShipmentInvoiceStatusResponse

货运发票状态响应.

Name Description Schema
Shipments
optional
The shipment invoice status information. ShipmentInvoiceStatusInfo

<a name="getinvoicestatusresponse">

# GetInvoiceStatusResponse

getInvoiceStatus操作的响应模式.

Name Description Schema
payload
optional
The payload for the getInvoiceStatus operation. ShipmentInvoiceStatusResponse
errors
optional
请求不成功时返回的错误响应列表. ErrorList
Last Updated: 2022/10/17 下午9:17:02