BR market: Updated API workflow to support Order, Invoice and Warehouse

资料正文

§1 BR market: Updated API workflow to support Order, Invoice and Warehouse

§2 Summary

Summary

In the Brazil market, marketplace sellers are required to upload invoices to marketplace before they can fulfill the order. So the API workflow has been adjusted and new fields added to fit into the invoicing process.

§3 Affected Markets and Versions

Affected Markets and Versions

This change applies to the BR market and v202309 of the API.

§4 API Changes

API Changes

Please refer to the developer guide on how to manage BR market by effectively using the invoicing and fulfillment APIs

§5 Get Order List, Get Order Detail

Get Order List, Get Order Detail

Responses have the following new properties:

need_upload_invoice: Whether an invoice needs to be uploaded (only for Brazil market).
UNKNOWN
NEED_INVOICE
NO_NEED
INVOICE_UPLOADED
CPF: CPF (invoice number) used to issue an invoice. Exclusive for the Brazil market.
CPF_name: Name belonging to the CPF number for the Brazil market.

§6 Upload Invoice

Upload Invoice

A new Upload Invoice endpoint to upload the invoice document. Note: Applicable only for local sellers in the Brazil market.

§7 Get Package Shipping Document

Get Package Shipping Document

A new input parameter INVOICE_LABEL. For Brazil market only, document_size is fixed to A6, and you don't need to specify document_size.

§8 Get Warehouse List

Get Warehouse List

Get Warehouse List retrieves all warehouse information associated with the seller. Compared with other markets (e.g. US market), the warehouse entity of Brazil market has four address lines, with each indicating:

Field	Description
address_line1	The first line of the warehouse address, like street name and street number. Note: For Brazilian market, this represents the neighborhood or district.
address_line2	The second line of the warehouse address, like flat, apartment, or suite. Note: For Brazilian market, this represents the street name.
address_line3	This represents the street number. If it's s/n, it means null. Note: Available only in Brazilian market.
address_line4	This represents supplementary information, like flat, apartment, or suite (optional). Note: Available only in Brazilian market.

§9 Webhook: Invoice Status Change

Webhook: Invoice Status Change

A new webhook that is triggered when the status of an invoice upload changes after using the POST Upload Invoice endpoint. Note: The POST Upload Invoice API is currently only applicable to the Brazil market.