GET
/
v1
/
retailers
/
{retailer_id}
/
invoices
curl --request GET \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/invoices/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 100,
  "next": "https://api.example.org/demo/{retailer_id}/?page=5",
  "previous": "https://api.example.org/demo/{retailer_id}/?page=3",
  "results": [
    {
      "id": 1,
      "retailer": {
        "id": 500,
        "name": "Demo Retailer",
        "code": "demo-retailer",
        "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
        "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
        "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
        "joined_at": "2021-08-03T17:24:12Z",
        "is_rcn_retailer": false,
        "is_onboarded": false,
        "platform": "fabric",
        "requires_subscription": "disabled",
        "brand_permit_creation_allowed": false,
        "website": "https://demoabc.com",
        "status": "active"
      },
      "brand": {
        "id": 500,
        "name": "Marla Cielo",
        "code": "demo-brand",
        "joined_at": "2022-09-10T15:24:56Z",
        "logo_url": "https://images.revcascade.com/retailers/defaults/logo-lg.png",
        "cover_url": "https://images.revcascade.com/retailers/defaults/cover.png",
        "profile_tile_url": "https://images.revcascade.com/retailers/defaults/profile-tile.png",
        "website": null,
        "is_onboarded": false,
        "is_on_rcn": false,
        "requires_subscription": "enabled",
        "subscription_expires_at": "2024-09-19T13:32:10Z",
        "grace_period_ends_at": "2024-10-26T13:32:10Z",
        "subscription_is_expired": false,
        "subscription_is_on_grace_period": false,
        "subscription_is_delinquent": false,
        "inventory_policy": "managed",
        "status": "active"
      },
      "connection_id": 2,
      "currency": {
        "id": 1,
        "name": "United States Dollar",
        "symbol": "$",
        "unit": "USD"
      },
      "invoice_number": "RC123456",
      "terms_type": "Previously agreed upon",
      "terms_description": "Previously agreed upon terms will apply",
      "terms_net_days_due": 35,
      "terms_date_due": null,
      "terms_discount_percent": null,
      "order_id": "O-654",
      "customer_order_number": "CO-435",
      "purchase_order_number": "PO-546",
      "status": "closed",
      "remit_to": {
        "id": 10,
        "type": "residential",
        "name1": "Demo Brand, Inc",
        "name2": null,
        "street1": "1332 Hermosa Ave",
        "street2": null,
        "city": "Hermosa Beach",
        "province": "CA",
        "postal_code": "90254",
        "country": "US",
        "phone1": "3105551212",
        "phone2": "3105551213",
        "fax": null,
        "email": null,
        "federal_tax_id": null
      },
      "ship_from": {
        "id": 10,
        "type": "residential",
        "name1": "Demo Brand, Inc",
        "name2": null,
        "street1": "1332 Hermosa Ave",
        "street2": null,
        "city": "Hermosa Beach",
        "province": "CA",
        "postal_code": "90254",
        "country": "US",
        "phone1": "3105551212",
        "phone2": "3105551213",
        "fax": null,
        "email": null,
        "federal_tax_id": null
      },
      "sold_to": {
        "id": 10,
        "type": "residential",
        "name1": "Demo Brand, Inc",
        "name2": null,
        "street1": "1332 Hermosa Ave",
        "street2": null,
        "city": "Hermosa Beach",
        "province": "CA",
        "postal_code": "90254",
        "country": "US",
        "phone1": "3105551212",
        "phone2": "3105551213",
        "fax": null,
        "email": null,
        "federal_tax_id": null
      },
      "ship_to": {
        "id": 10,
        "type": "residential",
        "name1": "Demo Brand, Inc",
        "name2": null,
        "street1": "1332 Hermosa Ave",
        "street2": null,
        "city": "Hermosa Beach",
        "province": "CA",
        "postal_code": "90254",
        "country": "US",
        "phone1": "3105551212",
        "phone2": "3105551213",
        "fax": null,
        "email": null,
        "federal_tax_id": null
      },
      "shipping_carrier_name": "ALZ carrier",
      "shipping_carrier_code": "230F",
      "shipping_account_number": "SH879",
      "shipping_method_name": "Next day delivery",
      "shipping_method_code": "ND",
      "shipping_tracking_number": "1Z9999999999999988",
      "shipping_weight": "7.00",
      "notes": "Signature required",
      "invoiced_at": "2022-05-10T15:24:56Z",
      "ordered_at": "2022-05-10T15:24:56Z",
      "shipped_at": "2022-05-10T15:24:56Z",
      "acknowledged_at": "2022-06-10T15:24:56Z",
      "paid_at": "2022-06-10T15:24:56Z",
      "closed_at": null,
      "canceled_at": null,
      "allowances": [
        {
          "id": 1,
          "adjustment_code": {
            "id": 1,
            "adjustment_type": "Allowance",
            "code": "returns_allowance",
            "description": "returns_allowance"
          },
          "description": "Sample-discount-allowance",
          "price": "12.10"
        }
      ],
      "charges": [
        {
          "id": 654,
          "adjustment_code": {
            "id": 1,
            "adjustment_type": "Allowance",
            "code": "returns_allowance",
            "description": "returns_allowance"
          },
          "description": "Sample invoice and its description",
          "price": "23.45"
        }
      ],
      "invoice_lines": [
        {
          "id": 765,
          "variant": {
            "id": 100024,
            "name": "T-Shirt, Blue, L",
            "brand": {
              "id": 500,
              "name": "Marla Cielo",
              "code": "demo-brand",
              "joined_at": "2022-09-10T15:24:56Z",
              "logo_url": "https://images.revcascade.com/retailers/defaults/logo-lg.png",
              "cover_url": "https://images.revcascade.com/retailers/defaults/cover.png",
              "profile_tile_url": "https://images.revcascade.com/retailers/defaults/profile-tile.png",
              "website": null,
              "is_onboarded": false,
              "is_on_rcn": false,
              "requires_subscription": "enabled",
              "subscription_expires_at": "2024-09-19T13:32:10Z",
              "grace_period_ends_at": "2024-10-26T13:32:10Z",
              "subscription_is_expired": false,
              "subscription_is_on_grace_period": false,
              "subscription_is_delinquent": false,
              "inventory_policy": "managed",
              "status": "active"
            },
            "brand_identifier": "1000-BL-L",
            "identifier": "5000001",
            "upc": 9119119111,
            "cartons": [
              {
                "id": 48,
                "number": 1,
                "length": "1",
                "length_unit": "1",
                "width": "1",
                "width_unit": "meter",
                "height": "1",
                "height_unit": "meter",
                "weight": "15",
                "weight_unit": "KG",
                "package_girth_inches": "1",
                "package_size_inches": "1"
              }
            ],
            "color": "Red",
            "style": "Print",
            "size": "Large",
            "media": [
              {
                "id": 249,
                "width": 100,
                "height": 100,
                "media": "default",
                "priority": 1,
                "url": "https://cdn.example.com/media/default/original",
                "updated_at": "2022-09-10T15:24:56Z",
                "created_at": "2022-08-10T15:24:56Z"
              }
            ],
            "attributes": [
              {
                "id": 44,
                "code": "size",
                "name": "Size",
                "editable_by": "brand",
                "grouping": "general",
                "description": "demo product description",
                "type": "money",
                "units": "USD",
                "values": {
                  "id": 123,
                  "value": "<string>",
                  "unit": {
                    "id": 677,
                    "name": "Sample unit",
                    "standard_unit": "<string>",
                    "type": "cost",
                    "system": "metric",
                    "symbol": "USD"
                  },
                  "retailer": {
                    "id": 500,
                    "name": "Demo Retailer",
                    "code": "demo-retailer",
                    "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
                    "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
                    "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
                    "joined_at": "2021-08-03T17:24:12Z",
                    "is_rcn_retailer": false,
                    "is_onboarded": false,
                    "platform": "fabric",
                    "requires_subscription": "disabled",
                    "brand_permit_creation_allowed": false,
                    "website": "https://demoabc.com",
                    "status": "active"
                  },
                  "updated_at": "2023-11-07T05:31:56Z",
                  "created_at": "2023-11-07T05:31:56Z"
                }
              }
            ],
            "ruleset_variants": [
              {
                "id": 1232,
                "status": "processing",
                "results": "<string>",
                "created_at": "2022-08-10T15:24:56Z",
                "updated_at": "2022-09-10T15:24:56Z"
              }
            ],
            "ruleset_variant_summary": "21",
            "active_permit": {
              "id": 10104,
              "retailer": {
                "id": 500,
                "name": "Demo Retailer",
                "code": "demo-retailer",
                "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
                "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
                "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
                "joined_at": "2021-08-03T17:24:12Z",
                "is_rcn_retailer": false,
                "is_onboarded": false,
                "platform": "fabric",
                "requires_subscription": "disabled",
                "brand_permit_creation_allowed": false,
                "website": "https://demoabc.com",
                "status": "active"
              },
              "retailer_price": "12.99",
              "retailer_cost": "8.99",
              "pricing": {},
              "attributes": {},
              "start_at": "2021-09-10T15:24:56Z",
              "end_at": "2024-09-10T15:24:56Z",
              "is_in_effect": true,
              "revoked_at": "2022-09-10T15:24:56Z",
              "is_acknowledged": true,
              "acknowledged_at": "2022-09-10T15:24:56Z"
            },
            "permits": [
              {
                "id": 10104,
                "retailer": {
                  "id": 500,
                  "name": "Demo Retailer",
                  "code": "demo-retailer",
                  "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
                  "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
                  "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
                  "joined_at": "2021-08-03T17:24:12Z",
                  "is_rcn_retailer": false,
                  "is_onboarded": false,
                  "platform": "fabric",
                  "requires_subscription": "disabled",
                  "brand_permit_creation_allowed": false,
                  "website": "https://demoabc.com",
                  "status": "active"
                },
                "retailer_price": "12.99",
                "retailer_cost": "8.99",
                "pricing": {},
                "attributes": {},
                "start_at": "2021-09-10T15:24:56Z",
                "end_at": "2024-09-10T15:24:56Z",
                "is_in_effect": true,
                "revoked_at": "2022-09-10T15:24:56Z",
                "is_acknowledged": true,
                "acknowledged_at": "2022-09-10T15:24:56Z"
              }
            ],
            "is_compatible": true,
            "proposal_variant": {
              "id": 3456,
              "pricing": "12.00",
              "attributes": [
                {
                  "id": 123,
                  "value": "<string>",
                  "unit": {
                    "id": 677,
                    "name": "Sample unit",
                    "standard_unit": "<string>",
                    "type": "cost",
                    "system": "metric",
                    "symbol": "USD"
                  },
                  "retailer": {
                    "id": 500,
                    "name": "Demo Retailer",
                    "code": "demo-retailer",
                    "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
                    "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
                    "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
                    "joined_at": "2021-08-03T17:24:12Z",
                    "is_rcn_retailer": false,
                    "is_onboarded": false,
                    "platform": "fabric",
                    "requires_subscription": "disabled",
                    "brand_permit_creation_allowed": false,
                    "website": "https://demoabc.com",
                    "status": "active"
                  },
                  "updated_at": "2023-11-07T05:31:56Z",
                  "created_at": "2023-11-07T05:31:56Z"
                }
              ],
              "memos": [
                {
                  "id": 1234,
                  "text": "Immediate requirement",
                  "visibility": "any",
                  "acknowledged_at": "2022-01-10T15:24:56Z",
                  "notify_people": true,
                  "created_by": {
                    "id": 542,
                    "first_name": "Sample",
                    "last_name": "Demo",
                    "title": "Demo",
                    "status": "Active",
                    "type": "standard",
                    "photo_url": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
                    "profile_photo": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
                    "is_me": true
                  },
                  "created_by_context": "retailer",
                  "created_at": "2021-09-10T15:24:56Z",
                  "updated_at": "2022-09-10T15:24:56Z"
                }
              ],
              "issues": [
                {
                  "id": 123,
                  "memos": [
                    {
                      "id": 1234,
                      "text": "Immediate requirement",
                      "visibility": "any",
                      "acknowledged_at": "2022-01-10T15:24:56Z",
                      "notify_people": true,
                      "created_by": {
                        "id": 542,
                        "first_name": "Sample",
                        "last_name": "Demo",
                        "title": "Demo",
                        "status": "Active",
                        "type": "standard",
                        "photo_url": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
                        "profile_photo": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
                        "is_me": true
                      },
                      "created_by_context": "retailer",
                      "created_at": "2021-09-10T15:24:56Z",
                      "updated_at": "2022-09-10T15:24:56Z"
                    }
                  ],
                  "created_at": "2023-11-07T05:31:56Z",
                  "updated_at": "2023-11-07T05:31:56Z",
                  "resolved_at": "2023-11-07T05:31:56Z",
                  "is_resolved": "<string>",
                  "issue_id": 123,
                  "message": "<string>",
                  "title": "<string>"
                }
              ],
              "variant_id": 249,
              "approved_at": "2022-10-10T15:24:56Z",
              "created_at": "2022-07-10T15:24:56Z",
              "updated_at": "2022-09-10T15:24:56Z",
              "rejected_at": null,
              "reject_reason": "Incomplete",
              "reject": true,
              "approve": false,
              "delete": false
            },
            "retailer_identifiers": {
              "id": 5642,
              "retailer": {
                "id": 500,
                "name": "Demo Retailer",
                "code": "demo-retailer",
                "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
                "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
                "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
                "joined_at": "2021-08-03T17:24:12Z",
                "is_rcn_retailer": false,
                "is_onboarded": false,
                "platform": "fabric",
                "requires_subscription": "disabled",
                "brand_permit_creation_allowed": false,
                "website": "https://demoabc.com",
                "status": "active"
              },
              "identifier": "SKU976",
              "name": "Retailer Sample"
            },
            "retailer_categories": {
              "id": 453,
              "retailer": {
                "id": 500,
                "name": "Demo Retailer",
                "code": "demo-retailer",
                "logo_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png",
                "cover_url": "https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg",
                "profile_tile_url": "https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg",
                "joined_at": "2021-08-03T17:24:12Z",
                "is_rcn_retailer": false,
                "is_onboarded": false,
                "platform": "fabric",
                "requires_subscription": "disabled",
                "brand_permit_creation_allowed": false,
                "website": "https://demoabc.com",
                "status": "active"
              },
              "category": "CategoryANC"
            },
            "inventory": {
              "discontinued": true,
              "discontinued_updated_at": null,
              "inventory": 0,
              "inventory_updated_at": "2022-09-10T15:24:56Z",
              "inventory_last_submitted_at": "2022-09-10T15:24:56Z",
              "brand_inventory_updated_at": "2022-09-10T15:24:56Z",
              "sellable": "No",
              "sellable_updated_at": "2022-11-10T15:24:56Z",
              "replenishable": true,
              "estimated_availability_date": "2022-09-10T15:24:56Z",
              "locations": [
                {
                  "id": 1,
                  "address": {
                    "id": 10,
                    "type": "residential",
                    "name1": "Demo Brand, Inc",
                    "name2": null,
                    "street1": "1332 Hermosa Ave",
                    "street2": null,
                    "city": "Hermosa Beach",
                    "province": "CA",
                    "postal_code": "90254",
                    "country": "US",
                    "phone1": "3105551212",
                    "phone2": "3105551213",
                    "fax": null,
                    "email": null,
                    "federal_tax_id": null
                  },
                  "inventory": 0,
                  "nickname": "LA Warehouse"
                }
              ]
            }
          },
          "invoice_line_number": 2,
          "item_brand_identifier": "Vend134",
          "item_upc": "911911911112",
          "quantity": 45,
          "name": "SamPro1",
          "description": "Sample description of product",
          "canceled_at": null,
          "price": "12.00",
          "retail_price": "14.00"
        }
      ],
      "net_amount": "12.89",
      "due_amount": "2.89",
      "expected_due_amount": "2.89",
      "subtotal": "10.89",
      "tax": "2.00",
      "invoice_acceptance": {
        "id": 565,
        "accepted_by": {
          "id": 542,
          "first_name": "Sample",
          "last_name": "Demo",
          "title": "Demo",
          "status": "Active",
          "type": "standard",
          "photo_url": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
          "profile_photo": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
          "is_me": true
        },
        "rejected_by": {
          "id": 542,
          "first_name": "Sample",
          "last_name": "Demo",
          "title": "Demo",
          "status": "Active",
          "type": "standard",
          "photo_url": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
          "profile_photo": "https://assets.demo.com/attachments/path_to_attachment/attachment.pdf",
          "is_me": true
        },
        "reject_reason": "Incorrect",
        "accepted_at": "2022-08-10T15:24:56Z",
        "rejected_at": null
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
retailer_id
number
required

The unique retailer ID. In the Dropship UI this is called the Merchant ID. To find your Merchant ID, click your merchant name in the top nav.

Query Parameters

​
search
string

Search by invoice or purchase order number

​
is_acknowledged
number

1: Acknowledged invoices | 0: Unacknowledged invoices

​
is_paid
number

1: Paid invoices |0: Unpaid invoices

​
invoiced_at_lt
number

Invoice date is less than specified Time (Unix epoch format)

​
invoiced_at_lte
number

Invoice date is less than or equal to specified Time (Unix epoch format)

​
invoiced_at_gt
number

Invoice date is greater than specified Time (Unix epoch format)

​
invoiced_at_gte
number

Invoice date is greater than or equal to specified unix Time

​
terms_date_due_lt
number

Invoice due date is less than specified Time (Unix epoch format)

​
terms_date_due_lte
number

Invoice due date is less than or equal to specified Time (Unix epoch format)

​
terms_date_due_gt
number

Invoice due date is greater than specified Time (Unix epoch format)

​
terms_date_due_gte
number

Invoice due date is greater than or equal to specified Time (Unix epoch format)

​
connection_id
number[]

Connection ID. Multiple values may be separated by commas.

​
brand_id
number[]

Vendor IDs. Multiple values may be separated by commas.

​
retailer_id
number[]

Retailer IDs. Multiple values may be separated by commas.

​
payment_id
number[]

Payment IDs. Multiple values may be separated by commas.

​
has_payment
number

1: Invoice is paid |0: Invoice is unpaid

​
purchase_order_number
string

Purchase order number

​
total_due_lt
number

Total due amount is less than the specified amount

​
total_due_lte
number

Total due amount is less than or equal to the specified amount

​
total_due_gt
number

Total due amount is greater than the specified amount

​
total_due_gte
number

Total due amount is greater than or equal to the specified amount

​
paid_at_lt
number

Date paid is less than specified Time (Unix epoch format)

​
paid_at_lte
number

Date paid is less than or equal to specified Time (Unix epoch format)

​
paid_at_gt
number

Date paid is greater than specified Time (Unix epoch format)

​
paid_at_gte
number

Date paid is greater than or equal to specified Time (Unix epoch format)

​
order_closed_at_lt
number

Order close date is less than specified Time (Unix epoch format).

​
order_closed_at_lte
number

Order close date is less than or equal to specified Time (Unix epoch format).

​
order_closed_at_gt
number

Order close date is greater than specified Time (Unix epoch format)

​
order_closed_at_gte
number

Order close date is greater than or equal to specified Time (Unix epoch format)

​
order_by
string

Sorting preference

​
page
integer

Page number within the paginated response

​
limit
integer

Number of records per page

Response

200 - application/json

OK

The response is of type object.