v1

latestOpenAPI 3.0.12026-07-2412502.6 MB

Order Offers

Add notes

Add note to an existing order offer.

post/order_offers/{order_offer_id}/notes

Request body

order_offer_notesstring required

Apply note to the history of this order offer.

Response

order_offer_idinteger

connection_order_offer_idstring nullable

status_type_idnull | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 nullable

1 - Active
2 - Cancelled
3 - Complete
4 - Partial
5 - Declined
6 - Archive
7 - Rejected
8 - Removed
9 - Paused
10 - Expired

linked_status_type_idnull | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 nullable

1 - Active
2 - Cancelled
3 - Complete
4 - Partial
5 - Declined
6 - Archive
7 - Rejected
8 - Removed
9 - Paused
10 - Expired

date_cancelstring date-time nullable

date_createdstring date-time nullable

date_modifiedstring date-time nullable

date_orderedstring date-time nullable

date_reactivatestring date-time nullable

date_pausestring date-time nullable

date_unpausestring date-time nullable

is_giftboolean

is_recurringboolean

is_testboolean

offer_idinteger

offer_namestring

order_idinteger

order_offer_pricestring

order_offer_quantityinteger

cancel_type_idinteger nullable

cancel_byinteger nullable

discount_idinteger nullable

order_offer_upsellboolean

parent_order_offer_idinteger nullable

charge_timeframe_idinteger nullable

charge_timeframe_namestring nullable

offer_cycle_multiple_shipments_countinteger

fulfillment_delay_timeframe_idinteger nullable

total_shipments_countinteger

shipped_shipments_countinteger

current_shipment_prepaid_cycleinteger nullable

current_shipment_idinteger nullable

connection_status_type_namestring

last_recurring_datestring date-time nullable

last_recurring_amountstring

next_recurring_datestring date-time nullable

next_recurring_amountstring

next_recurring_pricestring

next_recurring_chargeinteger nullable

next_recurring_last_fourstring nullable

extra_fieldsstring nullable

order_offer_notesstring nullable

Example response

{
  "date_cancel": "2023-04-01 00:00:00",
  "date_created": "2023-04-01 00:00:00",
  "date_modified": "2023-04-01 00:00:00",
  "date_ordered": "2023-04-01 00:00:00",
  "date_reactivate": "2023-04-01 00:00:00",
  "date_pause": "2023-04-01 00:00:00",
  "date_unpause": "2023-04-01 00:00:00",
  "last_recurring_date": "2023-04-01 00:00:00",
  "next_recurring_date": "2023-04-01 00:00:00",
  "order_offer_shipments": [
    {
      "date_cancel": "2023-04-01 00:00:00",
      "date_scheduled": "2023-04-01 00:00:00",
      "date_complete": "2023-04-01 00:00:00",
      "date_scan": "2023-04-01 00:00:00",
      "date_deliver": "2023-04-01 00:00:00",
      "date_return": "2023-04-01 00:00:00",
      "date_skip": "2023-04-01 00:00:00",
      "date_rma": "2023-04-01 00:00:00",
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00",
      "customer_address_billing": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "customer_address_shipping": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "tracking_history": [
        {
          "date": "2023-04-01 00:00:00"
        }
      ]
    }
  ],
  "order_offer_items": [
    {
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00"
    }
  ],
  "discount": {
    "discount_expiration_date": "2023-04-01 00:00:00",
    "discount_offers": [
      {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00",
        "offer_cycles": [
          {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00",
            "offer_cycle_items": [
              {
                "date_created": "2023-04-01 00:00:00",
                "date_modified": "2023-04-01 00:00:00"
              }
            ],
            "charge_timeframe": {
              "date_created": "2023-04-01 00:00:00",
              "date_modified": "2023-04-01 00:00:00"
            }
          }
        ],
        "offer_timeframes": [
          {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          }
        ],
        "offer_swap_options": [
          {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          }
        ]
      }
    ]
  },
  "order_offer_next_transactions": [
    {
      "date_scheduled": "2023-04-01 00:00:00",
      "date_complete": "2023-04-01 00:00:00",
      "date_cancelled": "2023-04-01 00:00:00",
      "date_skip": "2023-04-01 00:00:00",
      "date_batch": "2023-04-01 00:00:00",
      "date_deposit": "2023-04-01 00:00:00",
      "date_request": "2023-04-01 00:00:00",
      "date_response": "2023-04-01 00:00:00",
      "rebill_date": "2023-04-01 00:00:00",
      "original_attempt_date": "2023-04-01 00:00:00",
      "parent_date_complete": "2023-04-01 00:00:00",
      "chargeback_date": "2023-04-01 00:00:00",
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00",
      "order": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00",
        "date_authorized": "2023-04-01 00:00:00",
        "date_auto_capture": "2023-04-01 00:00:00",
        "date_ordered": "2023-04-01 00:00:00",
        "date_capture": "2023-04-01 00:00:00"
      },
      "order_revisions": [
        {
          "date_modified": "2023-04-01 00:00:00"
        }
      ],
      "customer": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00",
        "customer_cards": [
          {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          }
        ],
        "customer_addresses": [
          {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          }
        ]
      },
      "customer_card": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "customer_address_billing": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "customer_address_shipping": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "merchant": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "sale": {
        "date_sale": "2023-04-01 00:00:00",
        "date_attempt": "2023-04-01 00:00:00"
      },
      "credits": [
        {
          "date_scheduled": "2023-04-01 00:00:00",
          "date_complete": "2023-04-01 00:00:00",
          "date_cancelled": "2023-04-01 00:00:00",
          "date_skip": "2023-04-01 00:00:00",
          "date_batch": "2023-04-01 00:00:00",
          "date_deposit": "2023-04-01 00:00:00",
          "date_request": "2023-04-01 00:00:00",
          "date_response": "2023-04-01 00:00:00",
          "rebill_date": "2023-04-01 00:00:00",
          "original_attempt_date": "2023-04-01 00:00:00",
          "parent_date_complete": "2023-04-01 00:00:00",
          "chargeback_date": "2023-04-01 00:00:00",
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00"
        }
      ],
      "line_items": [
        {
          "date_complete": "2023-04-01 00:00:00"
        }
      ],
      "shipments": [
        {
          "date_cancel": "2023-04-01 00:00:00",
          "date_scheduled": "2023-04-01 00:00:00",
          "date_complete": "2023-04-01 00:00:00",
          "date_scan": "2023-04-01 00:00:00",
          "date_deliver": "2023-04-01 00:00:00",
          "date_return": "2023-04-01 00:00:00",
          "date_skip": "2023-04-01 00:00:00",
          "date_rma": "2023-04-01 00:00:00",
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00",
          "customer_address_billing": {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          },
          "customer_address_shipping": {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          },
          "tracking_history": [
            {
              "date": "2023-04-01 00:00:00"
            }
          ]
        }
      ],
      "route_logs": [
        {
          "date_complete": "2023-04-01 00:00:00",
          "date_created": "2023-04-01 00:00:00"
        }
      ]
    }
  ],
  "order_offer_gifts": [
    {
      "gift_date": "2023-04-01 00:00:00",
      "gift_date_sent": "2023-04-01 00:00:00"
    }
  ],
  "customer_address_billing": {
    "date_created": "2023-04-01 00:00:00",
    "date_modified": "2023-04-01 00:00:00"
  },
  "customer_address_shipping": {
    "date_created": "2023-04-01 00:00:00",
    "date_modified": "2023-04-01 00:00:00"
  }
}