This endpoint creates orders for merchants in Extend’s system. Orders should represent the order that is processed through a merchant’s store, with additional details that enable Extend to determine when to create a warranty contract or lead.

Orders will require at least one order line item to be created. Extend will automatically categorize that order line item based on the information that is sent with it. Here are the line item types used:

  • Extended Warranty Contract - This is determined by receiving a Plan ID and Product and will trigger an extended warranty contract to be created (optionally, a lead token can be sent with this type of line item in place of the product).
  • Category Contract - This is determined by receiving a line item type of category_contract, a valid plan object, and a product list object with all products that should be covered by the contract.
  • Category Product - This is determined by receiving a line item with only a product object and that product reference ID is covered by a category_contract line item.
  • Lead - This is determined by receiving no Plan ID on a warrantable Product and will trigger a lead to be created
  • Shipping Protection Contract - This is determined by receiving Shipment Info and a Quote ID and will trigger a shipping protection contract to be created.
  • Non-Warrantable - This is determined if the order line item is not an extended warranty contract, lead, or shipping protection.

Orders can also capture shipping information related to the products being shipped to the customer. This helps keep customer orders and contracts up-to-date in Extend’s system and may be required for certain contract types like shipping protection.

Here are definitions that may be helpful related to fields that are used when creating orders.

  • status (at the order level)
    • pending - An order that has been created with a wait period value. This is typically used to create an order that requires a certain time period to pass before it is considered a valid order.
    • open - An order that has been created with at least one order line item that has not been fulfilled (e.g. merchant hasn’t shipped the item or customer hasn’t received product).
    • voided - An order that was voided due to circumstances that indicate the order was not valid when it was first created. This can be due to a fraudulent order.
    • closed - An order was successfully processed with all order line items fulfilled.
    • canceled - An order that was canceled or refunded at the request of a customer or the merchant.
  • status (at the line item level)
    • canceled - The order line item has been canceled. When a line item is canceled, this will trigger a cancellation of an associated Extend contract on the line item.

    • cancel_failed - The attempt to cancel the order line item has failed. This is typically due to logic in Extend’s system preventing the cancelation (e.g. attempt to cancel a line item when there is an associated shipment).

    • contract_failed - The attempt to create an Extend contract from the order line item has failed. This is typically due to expected fields or values being invalid or incorrect on the order line item, specifically at the product, plan, or offers level.

    • contract_pending - A contract that will be created from the order line item is pending a wait period provided on the order.

    • fulfilled - The product on the order line item has been fulfilled (e.g. product is available or will be made available to the customer). Once an order line item is in the fulfilled status, any associated Extend contract to the line item will be created.

    • lead_failed - The attempt to create an Extend lead contract from the order line item has failed. This is typically due to expected fields or values being invalid or incorrect on the order line item.

    • quote_failed - The attempt to create a shipping protection contract from the order line item has failed. This is typically due to expected fields or values being invalid or incorrect on the order line item.

    • pending - An order line item that has been created where the order has a wait period value. This is typically used to create an order that requires a certain time period to pass before it is considered a valid order.

    • refunded - A successful refund has been made by the merchant to the customer on the order line item.

    • unfulfilled - An order line item has been created but the product associated has not been fulfilled yet.

Language
Click Try It! to start a request and see the response here!