Articles in this section

Deliverr API Guide - Order Fulfillment

Note: This guide is meant to be accompanied with Deliverr's API spec: https://api.deliverr.com/documentation/v1/spec


Order Fulfillment For Individual Products

For order fulfillment and management, you will require the api/products and api/orders scopes.

  1. Set up Products 

  2. Create Inbounds

    • Once you have created products, you can create inbounds via Seller Portal for these products. For more information on how to create inbounds in Seller Portal, please visit this link. If you are using existing Deliverr products and already have inventory for those products you can ignore this step.

  3. Create Orders

    • Once you have products created and you have live inventory for those products, you can start creating orders! For information on how to set the shipping speeds for your order, please visit this link. You can create orders via the Create Order endpoint. 

    • Please reference the Create Order API reference to see the definition of each field in the Create Order body schema

       

      curl --location --request POST '<https://api.deliverr.com/orders/v1/order>' \\
--header 'Authorization: Bearer {valid_access_token}' \\
--header 'Content-Type: application/json' \\
--data-raw '{
  "externalOrderId": "string",
  "source": "string",
  "sourceOrderId": "string",
  "shiptoAddress": {
    "name": "string",
    "company": "string",
    "street1": "string",
    "street2": "string",
    "city": "string",
    "state": "string",
    "postcode": "string",
    "countryCode": "string"
  },
  "lineItems": [
    {
      "externalProductId": "string",
      "quantity": 0
    }
  ],
  "orderDeliveryTime": "2019-08-24T14:15:22Z",
  "shipMethod": "string",
  "orderShipmentTime": "2019-08-24T14:15:22Z",
  "orderCreationTime": "2019-08-24T14:15:22Z"
}'

      After creating an order, you will receive an orderId field in the response to track the order. You can see the order on Seller Portal at https://sellerportal.deliverr.com/orders/{orderId}/detail


      Error Type Description
      ORDER_INVENTORY_DSKU_NEVER_INBOUNDED The product associated has never been inbounded. Please create an inbound shipment for the product, before submitting orders against it.
       PRODUCT_NOT_APPROVED_FOR_SALE  The product is not approved for sale. Please correct the product definition and ensure it has all the required fields such as dimensions or verification of hazardous material.
       ORDER_CANNOT_BE_FULFILLED Missing lineItems object representing the products to fulfill. Please update the order definition.
       ORDER_MISSING_LINE_ITEM Missing externalproductID for one of the lineItems objects. Please update the order definition.
       ORDER_MISSING_SHIPPING_ADDRESS Missing shiptoAddress object. Please update the order definition.
       ORDER_MISSING_ADDRESS_LINE Missing street1 address field. Please update the order definition.
       ORDER_MISSING_CITY Missing city field. Please update the order definition.
       ORDER_MISSING_STATE_ZIP Missing state or zip fields; both are required for domestic orders. Please update the order definition.
       ORDER_INVALID_COUNTRY_CODE The countryCode field is invalid. Please update the order definition with a valid country code.
       ORDER_PRODUCT_MISSING_CUSTOMS Product does not have the minimum customs information required. Please update product definition.
       ORDER_PREVIOUSLY_SEEN_ERROR This order was already created in the last hour and it failed with an error. Please wait at least one hour before re-creating orders with errors.
       ORDER_SUBMITTED_TOO_EARLY This order was created within the order ingestion delay set for the merchant's account. Please wait until the ingestion delay window has passed, before re-creating the order.
       PRODUCT_NOT_AVAILABLE Contains item(s) that have never been inbounded. Please ensure that the product has inventory before creating orders against it.

  4. Tracking status of Orders

    • Once you have created orders, you can track them by registering webhooks and receiving ORDER_STATUS_UPDATE events (guide coming soon) or by using the Get Order Status endpoint

      <https://api.deliverr.com/orders/v1/order/{orderId}>

      In the response, you can look at the status field to see if the order has been shipped, and can see the shipment details and tracking numbers in the shipments field.

Related articles