GET
/
v1
/
retailers
/
{retailer_id}
/
orders
/
Get orders
curl --request GET \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/orders/ \
  --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": 1016,
      "customer_order_number": "100000",
      "purchase_order_number": "1234-100000",
      "retailer_order_number": "1225466845",
      "brand_identifier": "423432322",
      "retailer": {
        "id": "<any>",
        "name": "<any>",
        "code": "<any>",
        "logo_url": "<any>",
        "cover_url": "<any>",
        "profile_tile_url": "<any>",
        "joined_at": "<any>",
        "is_rcn_retailer": "<any>",
        "is_onboarded": "<any>",
        "platform": "<any>",
        "requires_subscription": "<any>",
        "brand_permit_creation_allowed": "<any>",
        "website": "<any>",
        "status": "<any>"
      },
      "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"
      },
      "brands": [
        {
          "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": 10,
      "shipping_method": {
        "id": 5,
        "name": "White Glove Bronze",
        "code": "cory_white_glove",
        "type": "ltl (less than truck load)",
        "carrier": {
          "id": 229,
          "name": "Cory Companies",
          "code": "CJCD"
        },
        "generic_shipping_method": {
          "id": 5,
          "name": "LTL",
          "description": "Less than truckload (LTL)",
          "type": "ltl"
        }
      },
      "requested_shipping_method_id": 768,
      "requested_shipping_method": {
        "id": 5,
        "name": "LTL",
        "description": "Less than truckload (LTL)",
        "type": "ltl"
      },
      "shipment_count": 1,
      "invoice_count": 1,
      "bill_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
      },
      "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
      },
      "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
      },
      "return_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
      },
      "allow_shipping_label_generation": true,
      "subtotal_charged": "25.96",
      "shipping_charged": "2.99",
      "is_gift": false,
      "gift_fee": null,
      "is_replacement": false,
      "status": "open",
      "currency": {
        "id": 1,
        "name": "United States Dollar",
        "symbol": "$",
        "unit": "USD"
      },
      "is_acknowledged": false,
      "ordered_at": "2017-08-01T12:00:00Z",
      "acknowledged_at": "2022-08-01T12:00:00Z",
      "fulfill_by": "2022-12-19T03:59:59Z",
      "fulfilled_at": null,
      "closed_at": null,
      "received_at": null,
      "is_on_hold": false,
      "pickup_on": null,
      "on_hold_at": null,
      "on_hold_until": null,
      "backordered_until": null,
      "backorder_acknowledged_at": null,
      "canceled_at": null,
      "updated_at": "2022-08-03T17:45:11Z",
      "order_lines": [
        {
          "id": 10013,
          "order_line_number": "SampleOL-1",
          "quantity": 2,
          "quantity_open": 2,
          "quantity_shipped": 0,
          "quantity_returned": 0,
          "quantity_canceled": 0,
          "quantity_invoiced": 0,
          "packages_per_quantity": 123,
          "price": "8.99",
          "net_price": "5.39",
          "subtotal": "17.98",
          "estimated_price": null,
          "shipping_charged": "0.00",
          "gift_fee": null,
          "subtotal_charged": "17.98",
          "tax_charged": "0.00",
          "total_charge": "12",
          "status": "open",
          "fulfill_by": "2022-12-19T03:59:59Z",
          "canceled_at": null,
          "ordered_at": "2022-08-01T12:00:00Z",
          "backordered_until": null,
          "variant": "<string>",
          "metadata": [
            {
              "id": 456,
              "name": "MD143",
              "value": "12",
              "type": "string",
              "created_at": "2022-09-10T15:24:56Z"
            }
          ]
        }
      ],
      "cancels": [
        {
          "id": 456,
          "retailer": {
            "id": 510,
            "code": "hobie_store",
            "name": "Hobie Store"
          },
          "brand": {
            "id": 456,
            "code": "marla-store",
            "name": "Marla Store"
          },
          "canceled_at": null,
          "canceled_by": "retailer",
          "cancel_lines": [
            {
              "id": 7898,
              "variant": "Var1",
              "quantity": 3,
              "estimated_availability_date": "12-12-2022"
            }
          ],
          "reason_id": 879,
          "order_id": "5465",
          "purchase_order_number": "CS192168",
          "reason": "Incorrect",
          "acknowledged_at": "2022-09-10T15:24:56Z"
        }
      ],
      "shipments": [
        {
          "id": 767,
          "order_id": 677,
          "batch_number": 6,
          "label_reference": "Sample label 123",
          "ordered_at": "2021-09-10T15:24:56Z",
          "customer_order_number": "765637",
          "retailer_order_number": "66367",
          "purchase_order_number": "PO-576",
          "shipping_method": {
            "id": 5,
            "name": "White Glove Bronze",
            "code": "cory_white_glove",
            "type": "ltl (less than truck load)",
            "carrier": {
              "id": 229,
              "name": "Cory Companies",
              "code": "CJCD"
            },
            "generic_shipping_method": {
              "id": 5,
              "name": "LTL",
              "description": "Less than truckload (LTL)",
              "type": "ltl"
            }
          },
          "shipping_account": {
            "id": 3,
            "nickname": "Hobie FedEx",
            "owner": "Sample Owner",
            "carrier": {
              "id": 229,
              "name": "Cory Companies",
              "code": "CJCD"
            },
            "is_first_party_bill": true
          },
          "tracking_number": "1Z9999999999999988",
          "tracking_url": "https://wwwapps.demo.com/WebTracking/track?track=yes&trackNums=1Z9999999999999988",
          "tracking": {
            "picked_up_at": "2022-08-10T15:24:56Z",
            "delivered_at": "2022-09-10T15:24:56Z",
            "tracking_details": [
              {
                "id": 78895456,
                "Time": "10-10-2022",
                "status": "Delivered",
                "status_detail": "Out for delivery",
                "country": "USA",
                "state": "New york",
                "city": "New york",
                "postal_code": "123R32"
              }
            ]
          },
          "status": "Shipped",
          "is_acknowledged": true,
          "has_commercial_invoice": true,
          "canceled_at": 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
          },
          "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
          },
          "ship_weight": 10,
          "ship_width": 1,
          "ship_length": 1,
          "ship_height": 1,
          "ship_girth": "<string>",
          "ship_volume": 4,
          "valid_packing_slip": true,
          "valid_shipping_label": true,
          "shipping_provider_identifier": "shp_3a61e10243da49ab92f0e3861d5d256b",
          "error_logs": {
            "id": 677,
            "message": "Sample errors to fix",
            "count": 12,
            "created_at": "2022-08-10T15:24:56Z"
          },
          "acknowledged_at": "2022-08-10T15:24:56Z",
          "closed_at": null,
          "delivered_at": "2022-09-10T15:24:56Z",
          "shipped_at": "2022-09-10T15:24:56Z",
          "updated_at": "2022-09-10T15:25:56Z",
          "created_at": "2022-09-10T15:24:56Z",
          "shipment_lines": [
            {
              "id": 1001,
              "order_line_number": "1001",
              "quantity": 1,
              "part": 1,
              "freight_class": 50,
              "updated_at": "2022-09-10T15:24:56Z",
              "variant": {
                "id": 249,
                "name": "Var45",
                "brand": {
                  "id": 456,
                  "code": "marla-store",
                  "name": "Marla Store"
                },
                "identifier": "123-DEF12345",
                "brand_identifier": "HATR",
                "upc": 555555555202,
                "retailer_identifiers": [
                  {
                    "id": 5642,
                    "retailer": {},
                    "identifier": "SKU976",
                    "name": "Retailer Sample"
                  }
                ]
              }
            }
          ],
          "signature": null,
          "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"
          },
          "invoice_number": "RC123456"
        }
      ],
      "attachments": [
        {
          "id": 268,
          "content_type": 1,
          "object_id": 666,
          "file": "Sample file",
          "uploaded_by": 646,
          "visible_by": "connections",
          "original_filename": "Sample1",
          "filename": "Sample1",
          "tags": [
            {
              "id": "<any>",
              "tag": "<any>"
            }
          ],
          "url": "https://assets.sample.com/attachments/path_to_attachment/attachment.pdf"
        }
      ],
      "memos": [
        {
          "id": "<any>",
          "text": "<any>",
          "visibility": "<any>",
          "acknowledged_at": "<any>",
          "notify_people": "<any>",
          "created_by": "<any>",
          "created_by_context": "<any>",
          "created_at": "<any>",
          "updated_at": "<any>"
        }
      ],
      "memos_count": 1,
      "unread_memos_count": 0,
      "tags": [
        {
          "id": 536,
          "tag": "Demo tag",
          "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_at": "2022-09-10T15:24:56Z",
          "updated_at": "2022-10-10T15:24:56Z"
        }
      ],
      "gift_message": "Gift",
      "fill_time": null,
      "invoices": [
        {
          "id": 1,
          "retailer": {
            "id": "<any>",
            "name": "<any>",
            "code": "<any>",
            "logo_url": "<any>",
            "cover_url": "<any>",
            "profile_tile_url": "<any>",
            "joined_at": "<any>",
            "is_rcn_retailer": "<any>",
            "is_onboarded": "<any>",
            "platform": "<any>",
            "requires_subscription": "<any>",
            "brand_permit_creation_allowed": "<any>",
            "website": "<any>",
            "status": "<any>"
          },
          "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": [
            {}
          ],
          "charges": [
            {}
          ],
          "invoice_lines": [
            {}
          ],
          "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": {},
            "rejected_by": {},
            "reject_reason": "Incorrect",
            "accepted_at": "2022-08-10T15:24:56Z",
            "rejected_at": null
          }
        }
      ],
      "signature": null,
      "rmas": [
        {
          "id": 4,
          "order_id": 1000,
          "purchase_order_number": "CS192168",
          "rma_number": "ABC123",
          "status": "Pending",
          "currency": {
            "id": 1,
            "name": "United States Dollar",
            "symbol": "$",
            "unit": "USD"
          },
          "created_by": "Retailer",
          "rmad_at": "2022-09-10T15:24:56Z",
          "approved_at": "2022-09-10T15:24:56Z",
          "rejected_at": null,
          "ordered_at": "2022-09-10T15:24:56Z",
          "acknowledged_at": "2022-09-10T15:24:56Z",
          "rma_lines": [
            {
              "id": 567,
              "variant": {
                "id": "<any>",
                "name": "<any>",
                "brand": "<any>",
                "brand_identifier": "<any>",
                "identifier": "<any>",
                "upc": "<any>",
                "cartons": "<any>",
                "color": "<any>",
                "style": "<any>",
                "size": "<any>",
                "media": "<any>",
                "attributes": "<any>",
                "ruleset_variants": "<any>",
                "ruleset_variant_summary": "<any>",
                "active_permit": "<any>",
                "permits": "<any>",
                "is_compatible": "<any>",
                "proposal_variant": "<any>",
                "retailer_identifiers": "<any>",
                "retailer_categories": "<any>",
                "inventory": "<any>"
              },
              "quantity": 20,
              "quantity_shipped": 10,
              "net_price": "12.00"
            }
          ],
          "reason": "Incorrect",
          "reason_id": 344,
          "memos": [
            {
              "id": "<any>",
              "text": "<any>",
              "visibility": "<any>",
              "acknowledged_at": "<any>",
              "notify_people": "<any>",
              "created_by": "<any>",
              "created_by_context": "<any>",
              "created_at": "<any>",
              "updated_at": "<any>"
            }
          ],
          "attachments": [
            {
              "id": 268,
              "content_type": 1,
              "object_id": 666,
              "file": "Sample file",
              "uploaded_by": 646,
              "visible_by": "connections",
              "original_filename": "Sample1",
              "filename": "Sample1",
              "tags": [
                {
                  "id": "<any>",
                  "tag": "<any>"
                }
              ],
              "url": "https://assets.sample.com/attachments/path_to_attachment/attachment.pdf"
            }
          ],
          "retailer": {
            "id": "<any>",
            "name": "<any>",
            "code": "<any>",
            "logo_url": "<any>",
            "cover_url": "<any>",
            "profile_tile_url": "<any>",
            "joined_at": "<any>",
            "is_rcn_retailer": "<any>",
            "is_onboarded": "<any>",
            "platform": "<any>",
            "requires_subscription": "<any>",
            "brand_permit_creation_allowed": "<any>",
            "website": "<any>",
            "status": "<any>"
          },
          "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"
          },
          "total_amount": "34.00",
          "credits": [
            {
              "id": 20,
              "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"
              },
              "retailer": {
                "id": "<any>",
                "name": "<any>",
                "code": "<any>",
                "logo_url": "<any>",
                "cover_url": "<any>",
                "profile_tile_url": "<any>",
                "joined_at": "<any>",
                "is_rcn_retailer": "<any>",
                "is_onboarded": "<any>",
                "platform": "<any>",
                "requires_subscription": "<any>",
                "brand_permit_creation_allowed": "<any>",
                "website": "<any>",
                "status": "<any>"
              },
              "currency": {
                "id": 1,
                "name": "United States Dollar",
                "symbol": "$",
                "unit": "USD"
              },
              "rma": {},
              "invoice": {
                "id": 1,
                "retailer": {
                  "id": "<any>",
                  "name": "<any>",
                  "code": "<any>",
                  "logo_url": "<any>",
                  "cover_url": "<any>",
                  "profile_tile_url": "<any>",
                  "joined_at": "<any>",
                  "is_rcn_retailer": "<any>",
                  "is_onboarded": "<any>",
                  "platform": "<any>",
                  "requires_subscription": "<any>",
                  "brand_permit_creation_allowed": "<any>",
                  "website": "<any>",
                  "status": "<any>"
                },
                "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": [
                  {}
                ],
                "charges": [
                  {}
                ],
                "invoice_lines": [
                  {}
                ],
                "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": {},
                  "rejected_by": {},
                  "reject_reason": "Incorrect",
                  "accepted_at": "2022-08-10T15:24:56Z",
                  "rejected_at": null
                }
              },
              "order": "<string>",
              "credit_number": "849238",
              "credit_lines": [
                {
                  "id": 566,
                  "variant": {
                    "id": "<any>",
                    "name": "<any>",
                    "brand": "<any>",
                    "brand_identifier": "<any>",
                    "identifier": "<any>",
                    "upc": "<any>",
                    "cartons": "<any>",
                    "color": "<any>",
                    "style": "<any>",
                    "size": "<any>",
                    "media": "<any>",
                    "attributes": "<any>",
                    "ruleset_variants": "<any>",
                    "ruleset_variant_summary": "<any>",
                    "active_permit": "<any>",
                    "permits": "<any>",
                    "is_compatible": "<any>",
                    "proposal_variant": "<any>",
                    "retailer_identifiers": "<any>",
                    "retailer_categories": "<any>",
                    "inventory": "<any>"
                  },
                  "quantity": 10,
                  "net_price": "12.99"
                }
              ],
              "adjustments": [
                {
                  "id": 566,
                  "description": "Sample description for adjustment",
                  "net_price": "1.00"
                }
              ],
              "acknowledged_at": "2022-09-10T15:24:56Z",
              "credited_at": "2022-09-10T15:24:56Z",
              "created_at": "2022-08-10T15:24:56Z",
              "subtotal": "20.00",
              "credit_amount": "24.00"
            }
          ]
        }
      ],
      "credits": [
        {
          "id": 20,
          "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"
          },
          "retailer": {
            "id": "<any>",
            "name": "<any>",
            "code": "<any>",
            "logo_url": "<any>",
            "cover_url": "<any>",
            "profile_tile_url": "<any>",
            "joined_at": "<any>",
            "is_rcn_retailer": "<any>",
            "is_onboarded": "<any>",
            "platform": "<any>",
            "requires_subscription": "<any>",
            "brand_permit_creation_allowed": "<any>",
            "website": "<any>",
            "status": "<any>"
          },
          "currency": {
            "id": 1,
            "name": "United States Dollar",
            "symbol": "$",
            "unit": "USD"
          },
          "rma": {},
          "invoice": {
            "id": 1,
            "retailer": {
              "id": "<any>",
              "name": "<any>",
              "code": "<any>",
              "logo_url": "<any>",
              "cover_url": "<any>",
              "profile_tile_url": "<any>",
              "joined_at": "<any>",
              "is_rcn_retailer": "<any>",
              "is_onboarded": "<any>",
              "platform": "<any>",
              "requires_subscription": "<any>",
              "brand_permit_creation_allowed": "<any>",
              "website": "<any>",
              "status": "<any>"
            },
            "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": [
              {}
            ],
            "charges": [
              {}
            ],
            "invoice_lines": [
              {}
            ],
            "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": {},
              "rejected_by": {},
              "reject_reason": "Incorrect",
              "accepted_at": "2022-08-10T15:24:56Z",
              "rejected_at": null
            }
          },
          "order": "<string>",
          "credit_number": "849238",
          "credit_lines": [
            {
              "id": 566,
              "variant": {
                "id": "<any>",
                "name": "<any>",
                "brand": "<any>",
                "brand_identifier": "<any>",
                "identifier": "<any>",
                "upc": "<any>",
                "cartons": "<any>",
                "color": "<any>",
                "style": "<any>",
                "size": "<any>",
                "media": "<any>",
                "attributes": "<any>",
                "ruleset_variants": "<any>",
                "ruleset_variant_summary": "<any>",
                "active_permit": "<any>",
                "permits": "<any>",
                "is_compatible": "<any>",
                "proposal_variant": "<any>",
                "retailer_identifiers": "<any>",
                "retailer_categories": "<any>",
                "inventory": "<any>"
              },
              "quantity": 10,
              "net_price": "12.99"
            }
          ],
          "adjustments": [
            {
              "id": 566,
              "description": "Sample description for adjustment",
              "net_price": "1.00"
            }
          ],
          "acknowledged_at": "2022-09-10T15:24:56Z",
          "credited_at": "2022-09-10T15:24:56Z",
          "created_at": "2022-08-10T15:24:56Z",
          "subtotal": "20.00",
          "credit_amount": "24.00"
        }
      ],
      "order_batches": [
        {
          "id": 2456
        }
      ],
      "metadata": [
        {
          "id": 456,
          "name": "MD143",
          "value": "12",
          "type": "string",
          "created_at": "2022-09-10T15:24:56Z"
        }
      ],
      "connection_shipping_provider_account": {
        "id": 123,
        "connection": {
          "id": "1001",
          "brand": {},
          "retailer": {},
          "status": "active",
          "created_at": "2021-09-10T15:24:56Z",
          "level": "full",
          "options": {},
          "metadata": "About us",
          "connection_adjustments": [
            "<any>"
          ],
          "integration_type": "API",
          "retailer_identifier": "R566A"
        },
        "shipping_provider_account": {
          "id": 76546,
          "shipping_provider": {
            "id": 2455,
            "name": "Sample shipping provider",
            "credentials": "<string>",
            "shipping_methods": "Next day delivery",
            "created_at": "2021-09-10T15:24:56Z",
            "updated_at": "2022-09-10T15:24:56Z"
          },
          "shipping_methods": {
            "id": 5,
            "name": "White Glove Bronze",
            "code": "cory_white_glove",
            "type": "ltl (less than truck load)",
            "carrier": {
              "id": 229,
              "name": "Cory Companies",
              "code": "CJCD"
            },
            "generic_shipping_method": {
              "id": 5,
              "name": "LTL",
              "description": "Less than truckload (LTL)",
              "type": "ltl"
            }
          },
          "credential_values": [
            {
              "id": 165,
              "credential": {
                "id": 656,
                "code": "cred_sample",
                "name": "Cred Sample",
                "data_type": "text",
                "is_required": 1,
                "is_encrypted": 1,
                "created_at": "2021-09-10T15:24:56Z",
                "updated_at": "2022-09-10T15:24:56Z"
              },
              "value": "<string>",
              "created_at": "2021-09-10T15:24:56Z",
              "updated_at": "2022-09-10T15:24:56Z"
            }
          ],
          "created_at": "2021-09-10T15:24:56Z",
          "updated_at": "2022-09-10T15:24:56Z"
        },
        "shipping_methods": {
          "id": 5,
          "name": "White Glove Bronze",
          "code": "cory_white_glove",
          "type": "ltl (less than truck load)",
          "carrier": {
            "id": 229,
            "name": "Cory Companies",
            "code": "CJCD"
          },
          "generic_shipping_method": {
            "id": 5,
            "name": "LTL",
            "description": "Less than truckload (LTL)",
            "type": "ltl"
          }
        },
        "created_at": "2021-09-10T15:24:56Z",
        "updated_at": "2022-09-10T15:24:56Z"
      },
      "is_priority": false,
      "priority_user": {
        "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
      },
      "envelopes": [
        {
          "id": 663,
          "sender": {
            "id": 2344,
            "status": "active",
            "retailer": {
              "id": "<any>",
              "name": "<any>",
              "code": "<any>",
              "logo_url": "<any>",
              "cover_url": "<any>",
              "profile_tile_url": "<any>",
              "joined_at": "<any>",
              "is_rcn_retailer": "<any>",
              "is_onboarded": "<any>",
              "platform": "<any>",
              "requires_subscription": "<any>",
              "brand_permit_creation_allowed": "<any>",
              "website": "<any>",
              "status": "<any>"
            },
            "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"
            },
            "identifier": "SKU1",
            "secondary_identifier": "ACF1",
            "qualifier": "01"
          },
          "receiver": {
            "id": 2344,
            "status": "active",
            "retailer": {
              "id": "<any>",
              "name": "<any>",
              "code": "<any>",
              "logo_url": "<any>",
              "cover_url": "<any>",
              "profile_tile_url": "<any>",
              "joined_at": "<any>",
              "is_rcn_retailer": "<any>",
              "is_onboarded": "<any>",
              "platform": "<any>",
              "requires_subscription": "<any>",
              "brand_permit_creation_allowed": "<any>",
              "website": "<any>",
              "status": "<any>"
            },
            "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"
            },
            "identifier": "SKU1",
            "secondary_identifier": "ACF1",
            "qualifier": "01"
          },
          "edi": "<string>",
          "interchange_control_number": 2545,
          "data_interchange_control_number": 12455,
          "direction": "incoming",
          "request_acknowledgment": true,
          "functional_identifier": "PO",
          "sub_element_delimiter": "<string>",
          "segment_delimiter": "demo12",
          "element_delimiter": "<string>",
          "accepted_at": "2021-10-10T15:24:56Z",
          "created_at": "2021-09-10T15:24:56Z",
          "rejected_at": null,
          "transmitted_at": "2021-11-10T15:24:56Z",
          "documents": [
            {
              "id": 254,
              "jobs": [
                {
                  "id": 123,
                  "content_type": 1,
                  "object_id": 145,
                  "connection": {
                    "id": "1001",
                    "brand": {},
                    "retailer": {},
                    "status": "active",
                    "created_at": "2021-09-10T15:24:56Z",
                    "level": "full",
                    "options": {},
                    "metadata": "About us",
                    "connection_adjustments": [
                      "<any>"
                    ],
                    "integration_type": "API",
                    "retailer_identifier": "R566A"
                  },
                  "runtime_id": "<string>",
                  "module_name": "demo module",
                  "created_at": "2022-08-10T15:24:56Z",
                  "start_time": "2022-11-10T15:24:56Z",
                  "finish_time": "2022-11-10T15:24:56Z",
                  "description": "<string>",
                  "total_success": "<string>",
                  "total_failure": "<string>",
                  "metadata": [
                    {}
                  ],
                  "error_count": "<string>",
                  "error_logs": {
                    "id": 677,
                    "message": "Sample errors to fix",
                    "count": 12,
                    "created_at": "2022-08-10T15:24:56Z"
                  }
                }
              ],
              "transaction_set": "810",
              "transaction_set_control_number": 456,
              "accepted_at": "2021-09-10T15:24:56Z",
              "rejected_at": null
            }
          ],
          "entities": [
            {
              "id": 2145,
              "envelope": {},
              "content_type": "PDF",
              "object_id": 666
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
retailer_id
string
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

​
retailer_order_num
string

Retailer order number

​
tags
string[]

Tags used for categorization. Multiple values may be added, separated by commas.

​
metadata
string[]

Meta data. Multiple values may be added, separated by commas.

​
metadata_value
string

Metadata values

​
generic_shipping_method
string[]

Shipping methods (names). Multiple values may be added, separated by comma

​
purchase_order_number
string

Purchase order number

​
customer_order_number
string

Customer order number

​
retailer_order_number
string

Retailer order number

​
search_order_number
string

Search by purchase order number, customer order number or retailer order number

​
variant_id
number[]

Variant IDs. Multiple values may be separated by commas.

​
variant_identifier
string[]

Variant SKUs. Multiple values may be added, separated by commas.

​
retailer_category
string[]

Retailer categories. Multiple values may be separated by commas.

​
retailer_category_id
number[]

Retailer category IDs. Multiple values may be separated by commas.

​
workflow
string[]

Status of the order such as pending, new, creating_shipments, ship, invoice, creating_invoices, on_hold, closed, shipping_errors, and invoice_errors. Multiple values may be separated by commas.

​
status
string

Order status such as open, closed partial, *pending and cancelled.

​
shipment_status
string

Shipment status such as open, closed, partial, *pending, and cancelled

​
orderline_status
string

Order line status

​
is_gift
number

1: Order is a gift | 0: Order is not a gift

​
is_replacement
number

1: Order is a replacement | 0: Order is not a replacement

​
is_backordered
number

1: Product is backordered | 0: Product is not backordered

​
shipment_is_acknowledged
number

1: Shipment is acknowledged | 0: Shipment is not acknowledged

​
cancel_is_acknowledged
number

1: Cancellation is acknowledged | 0: Cancellation is not acknowledged

​
invoice_is_acknowledged
number

1: Invoice is acknowledged | 0: Invoice is not acknowledged

​
rma_is_acknowledged
number

1: RMA is acknowledged | 0: RMA is not acknowledged

​
backorder_is_acknowledged
number

1: Backorder is acknowledged | 0: Backorder is not acknowledged

​
has_shipments
number

1: Order has shipments | 0: Order does not have shipments

​
has_cancels
number

1: Order has cancellation | 0: Order does not have cancellation

​
has_invoices
number

1: Order has invoices | 0: Order does not have invoices

​
has_rmas
number

1: Order has RMA | 0: Order does not have RMA

​
not_fully_shipped
number

1: Order is not fully shipped | 0: Order is fully shipped

​
not_fully_invoiced
number

1: Order is not fully invoiced | 0: Order is fully invoiced

​
cancel_acknowledged_at_gt
number

Cancellation acknowledgement date is greater than specified Time (Unix epoch format)

​
cancel_acknowledged_at_gte
number

Cancellation acknowledgement date is greater than or equal to specified Time (Unix epoch format)

​
cancel_acknowledged_at_lt
number

Cancellation acknowledgement date is less than specified Time (Unix epoch format)

​
cancel_acknowledged_at_lte
number

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

​
backordered_until_gt
number

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

​
backordered_until_gte
number

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

​
backordered_until_lt
number

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

​
backordered_until_lte
number

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

​
memos_created_at_gte
number

Memos creation date is greater than or equal to specified Time (Unix epoch format)

​
since
number

Past date till the current time (Unix epoch format)

​
order_batch_id
number[]

Batch ID of order. Multiple values may be separated by commas.

​
brand_id
number[]

Vendor IDs. Multiple values may be separated by commas.

​
retailer_id
number[]

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.

​
connection_id
number[]

Connection ID. Multiple values may be separated by commas.Connection ID

​
order_by
string

Sorting preference

​
page
integer

Page number of the paginated response

​
limit
integer

Number of results per page

Response

200 - application/json

OK

​
count
integer
required

Total number of records

Example:

100

​
results
object[]
required
​
next
string<uri> | null

Next page (applicable in a paginated response)

Example:

"https://api.example.org/demo/{retailer_id}/?page=5"

​
previous
string<uri> | null

Previous page (applicable in a paginated response)

Example:

"https://api.example.org/demo/{retailer_id}/?page=3"