Skip to main content

Purchase Orders

Substitute your token for the square brackets placeholder in the header portion, and your location subdomain in the url portion as indicated below.

Listing​

You can fetch the list of purchase orders using the following API call:

curl -H "Authorization: Token [api_token]" https://[location_subdomain].datadocks.com/api/v1/purchase_orders

If your API token is 12345, and your location subdomain is toronto-acme this would look like:

curl -H "Authorization: Token 12345" https://toronto-acme.datadocks.com/api/v1/purchase_orders

Sample Payload​

[
  {
    "id": 1,
    "po_number": "A-1000",
    "name": "A-1000-FastCo-Cereal",
    "carrier_name": "FastCo",
    "location_name": "Toronto",
    "outbound": false,
    "expected_starts_at": "2020-10-09T13:35:00-04:00",
    "expected_ends_at": "2020-10-15T13:35:00-04:00",
    "custom_values": {
      "expected_at": "2020-10-09",
      "travel_type": "Plane",
      "forklift_operator": "Joe "
    },
    "purchase_order_items": [
      {
        "id": 2,
        "customer_name": "FishCo",
        "product_name": "Trout",
        "unit_name": "Skid",
        "quantity": 16,
        "weight": 102,
        "custom_values": {}
      },
      {
        "id": 1,
        "customer_name": "FishCo",
        "product_name": "Cereal",
        "unit_name": "Skid",
        "quantity": 33,
        "weight": 581,
        "custom_values": {}
      }
    ]
  },
  {
    "id": 2,
    "po_number": "A-2000",
    "name": "A-2000-FastCo-Laptops",
    "carrier_name": "FastCo",
    "location_name": "Vancouver",
    "outbound": false,
    "expected_starts_at": "2020-09-30T13:35:00-04:00",
    "expected_ends_at": "2020-10-14T13:35:00-04:00",
    "custom_values": {
      "travel_type": "Bike",
      "forklift_operator": "Frank"
    },
    "purchase_order_items": [
      {
        "id": 3,
        "customer_name": "FishCo",
        "product_name": "Laptops",
        "unit_name": "Box",
        "quantity": 40,
        "weight": 795,
        "custom_values": {
          "travel_type": "Truck",
          "forklift_operator": "Sam"
        }
      },
      {
        "id": 4,
        "customer_name": "FishCo",
        "product_name": "Trout",
        "unit_name": "Skid",
        "quantity": 10,
        "weight": 152,
        "custom_values": {
          "travel_type": "Bike",
          "forklift_operator": "Jenny"
        }
      }
    ]
  }
]

Fields​

id​

  • Type: Integer
  • Required: True
  • Description: DataDocks internal unique identifier.
  • Possible Values: Cannot be set externally.

po_number​

  • Type: String
  • Required: True
  • Description: Purchase order number.

name​

  • Type: String
  • Required: True
  • Description: Name that DataDocks assembled internally based on the values in fields and purchase order items.
  • Possible Values: Cannot be set externally.

carrier_name​

  • Type: String
  • Required: False
  • Description: The name of the carrier the purchase order is assigned to.

location_name​

  • Type: String
  • Required: False
  • Description: Name of the location associated with the purchase order.
  • Possible Values: Optional. Purchase order's don't have to be location specific.

outbound​

  • Type: Boolean
  • Required: True
  • Description: True if it is an outbound purchase order, False if it is an inbound purchase order. Defaults to False.

expected_starts_at​

  • Type: DateTime
  • Required: False
  • Description: When the purchase order is expected to start.

expected_ends_at​

  • Type: DateTime
  • Required: False
  • Description: When the purchase order is expected to end.

custom_values​

  • Type: Hash
  • Required: False
  • Description: A hash (object) of key / value pairs of the custom fields that have been filled out for the pourchase order.

purchase_order_items​

  • Type: Array
  • Required: False
  • Description: The items (packing lists) belonging to the purchase order.

purchase_order_items > id​

  • Type: Integer
  • Required: True
  • Description: DataDocks internal unique identifier.
  • Possible Values: Cannot be set externally.

purchase_order_items > customer_name​

  • Type: String
  • Required: False
  • Description: The name of the customer the item is associated with.

purchase_order_items > product_name​

  • Type: String
  • Required: True
  • Description: Name of the product the item is associated with.

purchase_order_items > unit_name​

  • Type: String
  • Required: False
  • Description: Name of the unit the item is associated with.

purchase_order_items > quantity​

  • Type: Decimal
  • Required: False
  • Description: The quantity.

purchase_order_items > weight​

  • Type: Decimal
  • Required: False
  • Description: The weight.

purchase_order_items > custom_values​

  • Type: Hash
  • Required: False
  • Description: A hash (object) of key / value pairs of the custom fields that have been filled out for the item.

Creating Purchase orders​

You can create a purchase order using the following API call and providing the purchase order data in JSON format.

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token [api_token]" \
  -X POST \
  -d '{"purchase_order": {"po_number": "A12345"}}' \
  https://[location_subdomain].datadocks.com/api/v1/purchase_orders

If your API token is 12345, and your location subdomain is toronto-acme this would look like:

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token 12345" \
  -X POST \
  -d '{"purchase_order": {"po_number": "A12345"}}' \
  https://toronto-acme.datadocks.com/api/v1/purchase_orders

Updating Purchase Orders​

You can update a purchase order using the following API call and providing the purchase order data in JSON format. Note that the URL requires the purchase order ID at the end (the DataDocks purchase order ID).

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token [api_token]" \
  -X PUT \
  -d '{"purchase_order": {"po_number": "A123456"}}' \
  https://[location_subdomain].datadocks.com/api/v1/purchase_orders/[purchase_order_id]

If your API token is 12345, your location subdomain is toronto-acme, and the purchase_order ID you want to update is 1 this would look like:

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token 12345" \
  -X PUT \
  -d '{"purchase_order": {"po_number": "A123456"}}' \
  https://toronto-acme.datadocks.com/api/v1/purchase_orders/1

Deleting Purchase Orders​

You can delete a purchase order using the following API call. Note that the URL requires the purchase order ID at the end (the DataDocks purchase order ID).

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token [api_token]" \
  -X DELETE \
  https://[location_subdomain].datadocks.com/api/v1/purchase_orders/[purchase_order_id]

If your API token is 12345, your location subdomain is toronto-acme, and the purchase_order ID you want to update is 1 this would look like:

curl -v \
  -H "Accept: application/json" \
  -H "Content-type: application/json" \
  -H "Authorization: Token 12345" \
  -X DELETE \
  https://toronto-acme.datadocks.com/api/v1/purchase_orders/1