POST
/
v1
/
retailers
/
{retailer_id}
/
sales-orders
/
Create a new order (mixed vendors)
curl --request POST \
  --url https://marketplace-api.fabric.inc/v1/retailers/{retailer_id}/sales-orders/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_order_number": "100000",
  "purchase_order_number": "1234-100000",
  "retailer_order_number": "1225466845",
  "brand_identifier": "423432322",
  "retailer": {
    "name": "Demo Retailer",
    "code": "demo-retailer",
    "is_rcn_retailer": false,
    "is_onboarded": false,
    "platform": "fabric",
    "requires_subscription": "disabled",
    "brand_permit_creation_allowed": false,
    "website": "https://demoabc.com",
    "status": "active"
  },
  "brand": {
    "name": "Marla Cielo",
    "code": "demo-brand",
    "website": null,
    "is_on_rcn": false,
    "requires_subscription": "enabled",
    "subscription_expires_at": "2024-09-19T13:32:10Z",
    "grace_period_ends_at": "2024-10-26T13:32:10Z",
    "inventory_policy": "managed",
    "status": "active"
  },
  "connection_id": 10,
  "shipping_method": {
    "name": "White Glove Bronze",
    "code": "cory_white_glove",
    "type": "ltl (less than truck load)",
    "carrier": {
      "name": "Cory Companies",
      "code": "CJCD"
    },
    "generic_shipping_method": {
      "name": "LTL",
      "description": "Less than truckload (LTL)",
      "type": "ltl"
    }
  },
  "requested_shipping_method_id": 768,
  "requested_shipping_method": {
    "name": "LTL",
    "description": "Less than truckload (LTL)",
    "type": "ltl"
  },
  "bill_to": {
    "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": {
    "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": {
    "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": {
    "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": {
    "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,
  "shipping_charged": "2.99",
  "is_gift": false,
  "gift_fee": null,
  "is_replacement": false,
  "currency": {
    "name": "United States Dollar",
    "symbol": "$"
  },
  "ordered_at": "2017-08-01T12:00:00Z",
  "acknowledged_at": "2022-08-01T12:00:00Z",
  "fulfilled_at": null,
  "pickup_on": null,
  "on_hold_at": null,
  "on_hold_until": null,
  "backordered_until": null,
  "backorder_acknowledged_at": null,
  "canceled_at": null,
  "fill_time": null,
  "signature": null,
  "connection_shipping_provider_account": {
    "connection": {
      "brand": {
        "name": "Marla Cielo",
        "code": "demo-brand",
        "website": null,
        "is_on_rcn": false,
        "requires_subscription": "enabled",
        "subscription_expires_at": "2024-09-19T13:32:10Z",
        "grace_period_ends_at": "2024-10-26T13:32:10Z",
        "inventory_policy": "managed",
        "status": "active"
      },
      "retailer": {
        "name": "Demo Retailer",
        "code": "demo-retailer",
        "is_rcn_retailer": false,
        "is_onboarded": false,
        "platform": "fabric",
        "requires_subscription": "disabled",
        "brand_permit_creation_allowed": false,
        "website": "https://demoabc.com",
        "status": "active"
      },
      "status": "active",
      "level": "full",
      "options": {
        "name": "Sample Option",
        "code": "Sample_Option",
        "description": "Sample description for connection",
        "viewable_by": "All",
        "editable_by": "Staff"
      },
      "integration_type": "API",
      "retailer_identifier": "R566A"
    },
    "shipping_provider_account": {
      "shipping_provider": {
        "name": "Sample shipping provider"
      },
      "shipping_methods": {
        "name": "White Glove Bronze",
        "code": "cory_white_glove",
        "type": "ltl (less than truck load)",
        "carrier": {
          "name": "Cory Companies",
          "code": "CJCD"
        },
        "generic_shipping_method": {
          "name": "LTL",
          "description": "Less than truckload (LTL)",
          "type": "ltl"
        }
      }
    },
    "shipping_methods": {
      "name": "White Glove Bronze",
      "code": "cory_white_glove",
      "type": "ltl (less than truck load)",
      "carrier": {
        "name": "Cory Companies",
        "code": "CJCD"
      },
      "generic_shipping_method": {
        "name": "LTL",
        "description": "Less than truckload (LTL)",
        "type": "ltl"
      }
    }
  },
  "is_priority": false,
  "priority_user": {
    "first_name": "Sample",
    "last_name": "Demo",
    "title": "Demo",
    "status": "Active",
    "type": "standard"
  }
}'
{
  "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": 432,
          "tag": "demotag"
        }
      ],
      "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": "<any>",
        "first_name": "<any>",
        "last_name": "<any>",
        "title": "<any>",
        "status": "<any>",
        "type": "<any>",
        "photo_url": "<any>",
        "profile_photo": "<any>",
        "is_me": "<any>"
      },
      "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": [
        {
          "id": 1,
          "adjustment_code": {},
          "description": "Sample-discount-allowance",
          "price": "12.10"
        }
      ],
      "charges": [
        {
          "id": 654,
          "adjustment_code": {},
          "description": "Sample invoice and its description",
          "price": "23.45"
        }
      ],
      "invoice_lines": [
        {
          "id": 765,
          "variant": {},
          "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": "<any>",
          "first_name": "<any>",
          "last_name": "<any>",
          "title": "<any>",
          "status": "<any>",
          "type": "<any>",
          "photo_url": "<any>",
          "profile_photo": "<any>",
          "is_me": "<any>"
        },
        "rejected_by": {
          "id": "<any>",
          "first_name": "<any>",
          "last_name": "<any>",
          "title": "<any>",
          "status": "<any>",
          "type": "<any>",
          "photo_url": "<any>",
          "profile_photo": "<any>",
          "is_me": "<any>"
        },
        "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": 100024,
            "name": "T-Shirt, Blue, L",
            "brand": {
              "id": "<any>",
              "name": "<any>",
              "code": "<any>",
              "joined_at": "<any>",
              "logo_url": "<any>",
              "cover_url": "<any>",
              "profile_tile_url": "<any>",
              "website": "<any>",
              "is_onboarded": "<any>",
              "is_on_rcn": "<any>",
              "requires_subscription": "<any>",
              "subscription_expires_at": "<any>",
              "grace_period_ends_at": "<any>",
              "subscription_is_expired": "<any>",
              "subscription_is_on_grace_period": "<any>",
              "subscription_is_delinquent": "<any>",
              "inventory_policy": "<any>",
              "status": "<any>"
            },
            "brand_identifier": "1000-BL-L",
            "identifier": "5000001",
            "upc": 9119119111,
            "cartons": [
              "<any>"
            ],
            "color": "Red",
            "style": "Print",
            "size": "Large",
            "media": [
              "<any>"
            ],
            "attributes": [
              "<any>"
            ],
            "ruleset_variants": [
              "<any>"
            ],
            "ruleset_variant_summary": "21",
            "active_permit": {
              "id": "<any>",
              "retailer": "<any>",
              "retailer_price": "<any>",
              "retailer_cost": "<any>",
              "pricing": "<any>",
              "attributes": "<any>",
              "start_at": "<any>",
              "end_at": "<any>",
              "is_in_effect": "<any>",
              "revoked_at": "<any>",
              "is_acknowledged": "<any>",
              "acknowledged_at": "<any>"
            },
            "permits": [
              "<any>"
            ],
            "is_compatible": true,
            "proposal_variant": {
              "id": "<any>",
              "pricing": "<any>",
              "attributes": "<any>",
              "memos": "<any>",
              "issues": "<any>",
              "variant_id": "<any>",
              "approved_at": "<any>",
              "created_at": "<any>",
              "updated_at": "<any>",
              "rejected_at": "<any>",
              "reject_reason": "<any>",
              "reject": "<any>",
              "approve": "<any>",
              "delete": "<any>"
            },
            "retailer_identifiers": {
              "id": "<any>",
              "retailer": "<any>",
              "identifier": "<any>",
              "name": "<any>"
            },
            "retailer_categories": {
              "id": "<any>",
              "retailer": "<any>",
              "category": "<any>"
            },
            "inventory": {
              "discontinued": "<any>",
              "discontinued_updated_at": "<any>",
              "inventory": "<any>",
              "inventory_updated_at": "<any>",
              "inventory_last_submitted_at": "<any>",
              "brand_inventory_updated_at": "<any>",
              "sellable": "<any>",
              "sellable_updated_at": "<any>",
              "replenishable": "<any>",
              "estimated_availability_date": "<any>",
              "locations": "<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": 432,
              "tag": "demotag"
            }
          ],
          "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": [
              {
                "id": 1,
                "adjustment_code": {},
                "description": "Sample-discount-allowance",
                "price": "12.10"
              }
            ],
            "charges": [
              {
                "id": 654,
                "adjustment_code": {},
                "description": "Sample invoice and its description",
                "price": "23.45"
              }
            ],
            "invoice_lines": [
              {
                "id": 765,
                "variant": {},
                "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": "<any>",
                "first_name": "<any>",
                "last_name": "<any>",
                "title": "<any>",
                "status": "<any>",
                "type": "<any>",
                "photo_url": "<any>",
                "profile_photo": "<any>",
                "is_me": "<any>"
              },
              "rejected_by": {
                "id": "<any>",
                "first_name": "<any>",
                "last_name": "<any>",
                "title": "<any>",
                "status": "<any>",
                "type": "<any>",
                "photo_url": "<any>",
                "profile_photo": "<any>",
                "is_me": "<any>"
              },
              "reject_reason": "Incorrect",
              "accepted_at": "2022-08-10T15:24:56Z",
              "rejected_at": null
            }
          },
          "order": "<string>",
          "credit_number": "849238",
          "credit_lines": [
            {
              "id": 566,
              "variant": {
                "id": 100024,
                "name": "T-Shirt, Blue, L",
                "brand": {
                  "id": "<any>",
                  "name": "<any>",
                  "code": "<any>",
                  "joined_at": "<any>",
                  "logo_url": "<any>",
                  "cover_url": "<any>",
                  "profile_tile_url": "<any>",
                  "website": "<any>",
                  "is_onboarded": "<any>",
                  "is_on_rcn": "<any>",
                  "requires_subscription": "<any>",
                  "subscription_expires_at": "<any>",
                  "grace_period_ends_at": "<any>",
                  "subscription_is_expired": "<any>",
                  "subscription_is_on_grace_period": "<any>",
                  "subscription_is_delinquent": "<any>",
                  "inventory_policy": "<any>",
                  "status": "<any>"
                },
                "brand_identifier": "1000-BL-L",
                "identifier": "5000001",
                "upc": 9119119111,
                "cartons": [
                  "<any>"
                ],
                "color": "Red",
                "style": "Print",
                "size": "Large",
                "media": [
                  "<any>"
                ],
                "attributes": [
                  "<any>"
                ],
                "ruleset_variants": [
                  "<any>"
                ],
                "ruleset_variant_summary": "21",
                "active_permit": {
                  "id": "<any>",
                  "retailer": "<any>",
                  "retailer_price": "<any>",
                  "retailer_cost": "<any>",
                  "pricing": "<any>",
                  "attributes": "<any>",
                  "start_at": "<any>",
                  "end_at": "<any>",
                  "is_in_effect": "<any>",
                  "revoked_at": "<any>",
                  "is_acknowledged": "<any>",
                  "acknowledged_at": "<any>"
                },
                "permits": [
                  "<any>"
                ],
                "is_compatible": true,
                "proposal_variant": {
                  "id": "<any>",
                  "pricing": "<any>",
                  "attributes": "<any>",
                  "memos": "<any>",
                  "issues": "<any>",
                  "variant_id": "<any>",
                  "approved_at": "<any>",
                  "created_at": "<any>",
                  "updated_at": "<any>",
                  "rejected_at": "<any>",
                  "reject_reason": "<any>",
                  "reject": "<any>",
                  "approve": "<any>",
                  "delete": "<any>"
                },
                "retailer_identifiers": {
                  "id": "<any>",
                  "retailer": "<any>",
                  "identifier": "<any>",
                  "name": "<any>"
                },
                "retailer_categories": {
                  "id": "<any>",
                  "retailer": "<any>",
                  "category": "<any>"
                },
                "inventory": {
                  "discontinued": "<any>",
                  "discontinued_updated_at": "<any>",
                  "inventory": "<any>",
                  "inventory_updated_at": "<any>",
                  "inventory_last_submitted_at": "<any>",
                  "brand_inventory_updated_at": "<any>",
                  "sellable": "<any>",
                  "sellable_updated_at": "<any>",
                  "replenishable": "<any>",
                  "estimated_availability_date": "<any>",
                  "locations": "<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": [
          {
            "id": 1,
            "adjustment_code": {},
            "description": "Sample-discount-allowance",
            "price": "12.10"
          }
        ],
        "charges": [
          {
            "id": 654,
            "adjustment_code": {},
            "description": "Sample invoice and its description",
            "price": "23.45"
          }
        ],
        "invoice_lines": [
          {
            "id": 765,
            "variant": {},
            "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": "<any>",
            "first_name": "<any>",
            "last_name": "<any>",
            "title": "<any>",
            "status": "<any>",
            "type": "<any>",
            "photo_url": "<any>",
            "profile_photo": "<any>",
            "is_me": "<any>"
          },
          "rejected_by": {
            "id": "<any>",
            "first_name": "<any>",
            "last_name": "<any>",
            "title": "<any>",
            "status": "<any>",
            "type": "<any>",
            "photo_url": "<any>",
            "profile_photo": "<any>",
            "is_me": "<any>"
          },
          "reject_reason": "Incorrect",
          "accepted_at": "2022-08-10T15:24:56Z",
          "rejected_at": null
        }
      },
      "order": "<string>",
      "credit_number": "849238",
      "credit_lines": [
        {
          "id": 566,
          "variant": {
            "id": 100024,
            "name": "T-Shirt, Blue, L",
            "brand": {
              "id": "<any>",
              "name": "<any>",
              "code": "<any>",
              "joined_at": "<any>",
              "logo_url": "<any>",
              "cover_url": "<any>",
              "profile_tile_url": "<any>",
              "website": "<any>",
              "is_onboarded": "<any>",
              "is_on_rcn": "<any>",
              "requires_subscription": "<any>",
              "subscription_expires_at": "<any>",
              "grace_period_ends_at": "<any>",
              "subscription_is_expired": "<any>",
              "subscription_is_on_grace_period": "<any>",
              "subscription_is_delinquent": "<any>",
              "inventory_policy": "<any>",
              "status": "<any>"
            },
            "brand_identifier": "1000-BL-L",
            "identifier": "5000001",
            "upc": 9119119111,
            "cartons": [
              "<any>"
            ],
            "color": "Red",
            "style": "Print",
            "size": "Large",
            "media": [
              "<any>"
            ],
            "attributes": [
              "<any>"
            ],
            "ruleset_variants": [
              "<any>"
            ],
            "ruleset_variant_summary": "21",
            "active_permit": {
              "id": "<any>",
              "retailer": "<any>",
              "retailer_price": "<any>",
              "retailer_cost": "<any>",
              "pricing": "<any>",
              "attributes": "<any>",
              "start_at": "<any>",
              "end_at": "<any>",
              "is_in_effect": "<any>",
              "revoked_at": "<any>",
              "is_acknowledged": "<any>",
              "acknowledged_at": "<any>"
            },
            "permits": [
              "<any>"
            ],
            "is_compatible": true,
            "proposal_variant": {
              "id": "<any>",
              "pricing": "<any>",
              "attributes": "<any>",
              "memos": "<any>",
              "issues": "<any>",
              "variant_id": "<any>",
              "approved_at": "<any>",
              "created_at": "<any>",
              "updated_at": "<any>",
              "rejected_at": "<any>",
              "reject_reason": "<any>",
              "reject": "<any>",
              "approve": "<any>",
              "delete": "<any>"
            },
            "retailer_identifiers": {
              "id": "<any>",
              "retailer": "<any>",
              "identifier": "<any>",
              "name": "<any>"
            },
            "retailer_categories": {
              "id": "<any>",
              "retailer": "<any>",
              "category": "<any>"
            },
            "inventory": {
              "discontinued": "<any>",
              "discontinued_updated_at": "<any>",
              "inventory": "<any>",
              "inventory_updated_at": "<any>",
              "inventory_last_submitted_at": "<any>",
              "brand_inventory_updated_at": "<any>",
              "sellable": "<any>",
              "sellable_updated_at": "<any>",
              "replenishable": "<any>",
              "estimated_availability_date": "<any>",
              "locations": "<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": {
        "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>"
      },
      "status": "active",
      "created_at": "2021-09-10T15:24:56Z",
      "level": "full",
      "options": {
        "id": 8753,
        "name": "Sample Option",
        "code": "Sample_Option",
        "description": "Sample description for connection",
        "viewable_by": "All",
        "editable_by": "Staff"
      },
      "metadata": "About us",
      "connection_adjustments": [
        {}
      ],
      "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": "<any>",
    "first_name": "<any>",
    "last_name": "<any>",
    "title": "<any>",
    "status": "<any>",
    "type": "<any>",
    "photo_url": "<any>",
    "profile_photo": "<any>",
    "is_me": "<any>"
  },
  "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": {
                  "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>"
                },
                "status": "active",
                "created_at": "2021-09-10T15:24:56Z",
                "level": "full",
                "options": {
                  "id": 8753,
                  "name": "Sample Option",
                  "code": "Sample_Option",
                  "description": "Sample description for connection",
                  "viewable_by": "All",
                  "editable_by": "Staff"
                },
                "metadata": "About us",
                "connection_adjustments": [
                  {}
                ],
                "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
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.

Body

application/json
​
purchase_order_number
string
required

Purchase order number

Minimum length: 1
Example:

"1234-100000"

​
ordered_at
string<date-time>
required

Time of order finalization (UTC format)

Example:

"2017-08-01T12:00:00Z"

​
customer_order_number
string | null

Customer order number

Maximum length: 64
Example:

"100000"

​
retailer_order_number
string

Retailer order number

Minimum length: 1
Example:

"1225466845"

​
brand_identifier
string | null

Vendor identifier

Maximum length: 64
Example:

"423432322"

​
retailer
object
​
brand
object
​
connection_id
integer

A numeric connection ID

Example:

10

​
shipping_method
object
​
requested_shipping_method_id
integer

ID of the requested shipping method

Example:

768

​
requested_shipping_method
object
​
bill_to
object
​
sold_to
object
​
ship_to
object
​
ship_from
object
​
return_to
object
​
allow_shipping_label_generation
boolean

true: Automatically generates shipping labels based on the carrier | false: Does not support generation of shipping labels

Example:

true

​
shipping_charged
string<decimal>

Shipped charged

Example:

"2.99"

​
is_gift
boolean

true: Order is a gift | false: Order is not a gift

Example:

false

​
gift_fee
string<decimal> | null

Gift fee (if applicable)

Example:

null

​
is_replacement
boolean

true: order is a replacement | false: order is not a replacement

Example:

false

​
currency
object
​
acknowledged_at
string<date-time> | null

Time of order acknowledgement (UTC format)

Example:

"2022-08-01T12:00:00Z"

​
fulfilled_at
string<date-time> | null

Time of order fulfillment (UTC format)

Example:

null

​
pickup_on
string<date> | null

Time of when order was picked up (UTC format)

Example:

null

​
on_hold_at
string<date-time> | null

Time of when order got placed on hold (UTC format)

Example:

null

​
on_hold_until
string<date> | null

Date till when the order will be on hold

Example:

null

​
backordered_until
string<date-time> | null

Time till when product or order is backordered (UTC format)

Example:

null

​
backorder_acknowledged_at
string<date-time> | null

Time of backorder acknowledgement (UTC format)

Example:

null

​
canceled_at
string<date-time> | null

Time of order cancellation (UTC format)

Example:

null

​
fill_time
string<decimal> | null

Fill time

Example:

null

​
signature
enum<string> | null

Represents whether signature is required

Available options:
required,
not_required,
adult
Example:

null

​
connection_shipping_provider_account
object
​
is_priority
boolean

true: Priority order | false: Not a priority order

Example:

false

​
priority_user
object

Response

201 - application/json

Ok

​
purchase_order_number
string
required

Purchase order number

Minimum length: 1
Example:

"1234-100000"

​
ordered_at
string<date-time>
required

Time of order finalization (UTC format)

Example:

"2017-08-01T12:00:00Z"

​
id
integer

Order ID

Example:

1016

​
customer_order_number
string | null

Customer order number

Maximum length: 64
Example:

"100000"

​
retailer_order_number
string

Retailer order number

Minimum length: 1
Example:

"1225466845"

​
brand_identifier
string | null

Vendor identifier

Maximum length: 64
Example:

"423432322"

​
retailer
object
​
brand
object
​
brands
object[]
​
connection_id
integer

A numeric connection ID

Example:

10

​
shipping_method
object
​
requested_shipping_method_id
integer

ID of the requested shipping method

Example:

768

​
requested_shipping_method
object
​
shipment_count
integer

Shipment count

Example:

1

​
invoice_count
integer

Invoice count

Example:

1

​
bill_to
object
​
sold_to
object
​
ship_to
object
​
ship_from
object
​
return_to
object
​
allow_shipping_label_generation
boolean

true: Automatically generates shipping labels based on the carrier | false: Does not support generation of shipping labels

Example:

true

​
subtotal_charged
string

Subtotal amount excluding shipping

Example:

"25.96"

​
shipping_charged
string<decimal>

Shipped charged

Example:

"2.99"

​
is_gift
boolean

true: Order is a gift | false: Order is not a gift

Example:

false

​
gift_fee
string<decimal> | null

Gift fee (if applicable)

Example:

null

​
is_replacement
boolean

true: order is a replacement | false: order is not a replacement

Example:

false

​
status
string

Order status

Minimum length: 1
Example:

"open"

​
currency
object
​
is_acknowledged
boolean

true: Order is acknowledged | false: Order is not acknowledged

Example:

false

​
acknowledged_at
string<date-time> | null

Time of order acknowledgement (UTC format)

Example:

"2022-08-01T12:00:00Z"

​
fulfill_by
string

Time when order will be completely fulfilled (UTC format)

Example:

"2022-12-19T03:59:59Z"

​
fulfilled_at
string<date-time> | null

Time of order fulfillment (UTC format)

Example:

null

​
closed_at
string<date-time>

Time of complete order fulfillment (UTC format)

Example:

null

​
received_at
string<date-time>

Time of when order was received (UTC format)

Example:

null

​
is_on_hold
boolean

true: Order is on hold | false: Order is not on hold

Example:

false

​
pickup_on
string<date> | null

Time of when order was picked up (UTC format)

Example:

null

​
on_hold_at
string<date-time> | null

Time of when order got placed on hold (UTC format)

Example:

null

​
on_hold_until
string<date> | null

Date till when the order will be on hold

Example:

null

​
backordered_until
string<date-time> | null

Time till when product or order is backordered (UTC format)

Example:

null

​
backorder_acknowledged_at
string<date-time> | null

Time of backorder acknowledgement (UTC format)

Example:

null

​
canceled_at
string<date-time> | null

Time of order cancellation (UTC format)

Example:

null

​
updated_at
string<date-time>

Time of order update (UTC format)

Example:

"2022-08-03T17:45:11Z"

​
order_lines
object[]
​
cancels
object[]
​
shipments
object[]
​
attachments
object[]
​
memos
object[]
​
memos_count
integer

Total memos

Example:

1

​
unread_memos_count
integer

Number of unread memos

Example:

0

​
tags
object[]
​
gift_message
string

Gift message

Example:

"Gift"

​
fill_time
string<decimal> | null

Fill time

Example:

null

​
invoices
object[]
​
signature
enum<string> | null

Represents whether signature is required

Available options:
required,
not_required,
adult
Example:

null

​
rmas
object[]
​
credits
object[]
​
order_batches
object[]
​
metadata
object[]
​
connection_shipping_provider_account
object
​
is_priority
boolean

true: Priority order | false: Not a priority order

Example:

false

​
priority_user
object
​
envelopes
object[]