Ana SayfaBelgelerKod ÖrnekleriAPI BaşvurusuDuyurularModellerSürüm NotlarıSSSGitHubVideolar
Geliştirici MerkeziAPI DurumuDestek
Belgeler
Geliştirici MerkeziAPI DurumuDestek

Faturalar API v2024-06-19 Kullanım Örneği Kılavuzu

Faturalar API'sini nasıl kullanacağınızı öğrenin.

API Sürümü: 2024-06-19

Faturalar API'si nedir?

Kullanabilirsiniz Faturalar için Satış Ortağı API'si Satış ortaklarının defter tutmalarını yönetmelerine yardımcı olabilecek fatura ile ilgili çeşitli işlemleri almak ve yönetmek.

Önemli

Bu API yalnızca geri alabilir Brezilya FBA faturaları. Bu API'yi diğer fatura türleri için kullanamazsınız.

Temel özellikler

  • Faturaları niteliklerine göre arayın
  • Faturaları dışa aktarın ve indirin

Terminoloji

  • Sefaz: Brezilya Devlet Vergi İdaresi (Secretaria da Fazenda).

Eğitim: Fatura dosyalarını dışa aktarma

Fatura dosyalarını nasıl dışa aktaracağınızı ve indireceğinizi öğrenin.

Ön koşullar

Bu eğitici içeriği tamamlamak için şunlara ihtiyacınız olacak:

  • Arama yaptığınız satış ortağından izin. Daha fazla bilgi için bkz. Satış Ortağı API uygulamalarını yetkilendirme.
  • Geliştirici profilinize atanan Vergi Faturalama rolü.
  • Başvurunuz için Uygulama kayıt sayfasında seçilen Vergi Faturalama rolü.

Adım 1. Fatura dışa aktarma oluşturma

Arayın createInvoicesExport işlem yapın ve dahil etmek istediğiniz pazar yerini, tarih aralığını ve isteğe bağlı parametreleri belirtin.

Talep başarılı olursa, yanıt şunları içerir: exportId değer.

Gövde parametreleri

AdAçıklamaZorunlu mu?
marketplaceIdİade edilen faturalar, belirttiğiniz pazar yeri ile eşleşir.
Tür: dize
Evet
dateStartYanıta dahil etmek istediğiniz faturalar için en erken fatura oluşturma tarihi. Tarihler içeride İSO 8601 biçim.
Tür: string (tarih)
Hayır
dateEndYanıta dahil etmek istediğiniz faturalar için en son fatura oluşturma tarihi. Tarihler içeride İSO 8601 biçim.
Tür: string (tarih)
Hayır

İpucu

Dışa aktarma işlem süresini azaltmak için, kısa tarih aralıklarını kullanın: dateStart ve dateEnd. En uygun aralık bir gündür.

İstek örneği

POST https://sellingpartnerapi-na.amazon.com/invoices/v1/exports?marketplaceId=A2Q3Y263D00KWC&dateStart=2024-07-09T00:00:00Z&dateEnd=2024-07-10T00:00:00Z

Yanıt

AdAçıklama
exportIdDışa aktarma tanımlayıcısı.
Tür: dize

Yanıt örneği

{ "exportId": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef" }

Adım 2. Dışa aktarma işleminin tamamlandığını doğrulayın

Periyodik olarak arayın getInvoicesExport operasyon - geçmek exportId İçinde aldığınız değer Adım 1- işlem tamamlanana kadar (processingStatus dır CANCELLED, DONE, veya FATAL). Bu noktada, yanıt şunları içerir: exportDocumentId fatura verileri mevcutsa değer.

Yol parametreleri

AdAçıklamaZorunlu mu?
exportIdDışa aktarma için tanımlayıcı.
Tür: dize
Evet

İstek örneği

GET https://sellingpartnerapi-na.amazon.com/invoices/v1/exports/4bdd8293-0cd7-4208-bed5-78b2c6ecefef

Yanıt

AdAçıklama
errorMessageDışa aktarma üretimi başarısız olduğunda, bu öznitelik hatanın bir açıklamasını içerir.
Tür: dize
exportDocumentIdsHer dışa aktarma belgesinin tanımlayıcılarını içeren bir liste.
Tür: dizi
exportIdDışa aktarma tanımlayıcısı.
Tür: dize
generateExportFinishedISO 8601 tarih-saat biçiminde ihracat üretiminin bittiği tarih ve saat.
Tür: dize
generateExportStartedISO 8601 tarih-saat biçiminde ihracat üretiminin başladığı tarih ve saat.
Tür: dize
statusİşleme durumu.
Tür: enum (REQUESTED, PROCESSING, DONE, ERROR)

Yanıt örneği

{ "export": { "errorMessage": "", "exportDocumentIds": [ "18c598f5-75db-4c1a-bd3e-4c64b36781c5" ], "exportId": "4bdd8293-0cd7-4208-bed5-78b2c6ecefef", "generateExportFinished": "2024-07-10T16:00:00.000Z", "generateExportStarted": "2024-07-10T15:00:00.000Z", "status": "DONE" } }

Adım 3. Fatura belgesi URL'sini alın

Arayın getInvoicesDocument operasyon, geçme exportDocumentId değeri Adım 2.

Yanıt, fatura dışa aktarma işlemine erişmek için kullanabileceğiniz önceden imzalanmış bir URL içerir. İçerik sıkıştırılırsa, sıkıştırma algoritması sağlanır. URL'nin süresi 30 saniye sonra sona eriyor.

Yol parametreleri

AdAçıklamaZorunlu mu?
invoicesDocumentIdDışa aktarma belgesinin tanımlayıcısı.
Tür: dize
Evet

İstek örneği

GET https://sellingpartnerapi-na.amazon.com/invoices/v1/documents/18c598f5-75db-4c1a-bd3e-4c64b36781c5

Yanıt

AdAçıklama
invoicesDocumentIdDışa aktarma belgesi tanımlayıcısı.
Tür: dize
invoicesDocumentUrlFaturaları indirmek için kullanabileceğiniz önceden imzalanmış bir URL (ZIP formatında).
Tür: dize

Yanıt örneği

{ "exportDocumentId": "18c598f5-75db-4c1a-bd3e-4c64b36781c5", "url": "https://d34o8swod1owfl.cloudfront.net/SampleResult%2BKey%3DSample%2BINITVEC%3D58+fa+bf+a7+08+11+95+0f+c1+a8+c6+e0+d5+6f+ae+c8" }

Bu sayfa size yardımcı oldu mu?