Invoice ID

Invoice API dùng để lấy danh sách các phiên đối soát và thanh toán COD của Goship. Sử dụng API này để liệt kê và tìm kiếm thông tin về phiên trả COD:

Danh sách các phiên đối soát

GET http://sandbox.goship.io/api/v2/invoices

Response data:

{
  "code": 200,
  "status": "success",
  "data": [
    {
      "id": "FA13HEUD",
      "amount": 12300000,
      "count": 123,
      "created_at": "21/03/2017 14:27"
    },
    {
      "id": "HDF9D9SS",
      "amount": 17100000,
      "count": 156,
      "created_at": "17/03/2017 16:40"
    }
  ]
}

Trong đó:

id: Mã phiếu thanh toán
amount: Số tiền COD đã thanh toán cho đối tác
count: Số vận đơn trong kỳ đối soát
created_at: Thời gian phát sinh giao dịch

Phân trang:

Mặc định API sẽ trả về 25 bản ghi. Để thay đổi giá trị này, chúng ta sử dụng tham số size trên query string, ví dụ:

GET http://sandbox.goship.io/api/v2/invoices?size=30

Để di chuyển giữa các trang, chúng ta sử dụng tham số page trên query string

GET http://sandbox.goship.io/api/v2/invoices?size=30&page=2

Tham khảo tài liệu mô tả về Phân trang

Tìm kiếm phiên đối soát COD

Chúng ta sử dụng tham số code trên query string để tìm kiếm cụ thể 1 phiên đối soát COD. code là mã phiên chuyển COD.

GET http://sandbox.goship.io/api/v2/invoices/search?code=HDF9D9SS

Hoặc tìm kiếm 1 danh sách các phiên đối soát theo thời gian sử dụng tham số from và to

from: Integer - Thời gian bắt đầu
to: Integer - Thời gian kết thúc

GET http://sandbox.goship.io/api/v2/invoices/search?from=12345678&to=87654321

Sử dụng phân trang tương tự như API Lấy tất cả phiên chuyển COD.

Tìm kiếm danh sách vận đơn theo mã phiên chuyển COD

GET http://sandbox.goship.io/api/v2/invoices/{code}/shipments

Trong đó, {code} là mã phiên chuyển COD. API sẽ trả ra thông tin của toàn bộ vận đơn có phát sinh COD trong phiên giao dịch.

Sử dụng phân trang tương tự như API Lấy tất cả phiên chuyển COD.

Response tương tự api danh sách vận đơn