Amazon SP API

getInvoiceStatus

Tested

GET

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

shipmentInvoice

Last modified:2024-12-09 08:56:45

Maintainer:Not configured

Returns the invoice status for the shipment you specify.

Usage Plan:

Rate (requests per second)	Burst
1.133	25

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Request

Path Params

shipmentId

string

required

The shipment identifier for the shipment.

Example:

shipmentId1

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://sandbox.sellingpartnerapi-na.amazon.com/fba/outbound/brazil/v0/shipments/shipmentId1/invoice/status'

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the getInvoiceStatus operation.

payload

object (ShipmentInvoiceStatusResponse)

optional

The shipment invoice status response.

Shipments

object (ShipmentInvoiceStatusInfo)

optional

The shipment invoice status information.

errors

array[object (Error) {3}]

optional

A list of error responses that are returned when a request is unsuccessful.

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

optional

Additional details that can help the caller understand or fix the issue.

Example

{
    "payload": {
        "Shipments": {
            "AmazonShipmentId": "string",
            "InvoiceStatus": "Processing"
        }
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

submitInvoice

getRates