Orders

Create Goodsout

Creates an order goodsout.

POST

/v1/orders/goodsouts

Create Goodsout

curl --request POST \
  --url 'https://public-api.bladepro.io/v1/orders/goodsouts?expand=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": "<any>",
  "bulk_options": "<any>",
  "date_placed": "<any>",
  "delivery_instructions": "<string>",
  "despatch_instructions": "<string>",
  "gift_message": "<string>",
  "gift_message_template_shortcode": "<string>",
  "import_options": "<any>",
  "lines": "<any>",
  "metadata": "<any>",
  "order": "<any>",
  "picking_instructions": "<string>",
  "retailer": 123,
  "shipping": "<any>",
  "shipping_address": "<any>",
  "tags": "<any>",
  "type": "<any>",
  "warehouse": "<string>"
}
'

{
  "data": {
    "attributes": [
      {
        "name": "Marketplace",
        "value": "202-9999999-9995900"
      }
    ],
    "cancellation_date": "2019-11-25T14:52:56.000Z",
    "date_placed": "2019-11-25T14:52:56.000Z",
    "delivery_instructions": "When not home put in shed.",
    "despatch_date": null,
    "despatch_on_date": null,
    "gift_message": "Happy birthday Sam!<br/>Hope you enjoy this gift.",
    "id": 1049789,
    "lines": [
      {
        "discount": 1.5,
        "discount_type": "percentage",
        "id": 3450345,
        "net_unit_principal": 12,
        "quantity": 4,
        "status": "active",
        "transaction_sku": "GREEN-BALL",
        "variation": {
          "barcode": "0123456789012",
          "created": "2019-11-25T14:52:56.000Z",
          "descriptions": [
            {
              "created": "2019-11-25T14:52:56.000Z",
              "full_description": "Example product description",
              "id": 1,
              "locale": {
                "code": "en",
                "created": "2019-11-25T14:52:56.000Z",
                "id": 1,
                "modified": "2019-11-25T14:52:56.000Z",
                "name": "English"
              },
              "locale_id": 1,
              "modified": "2019-11-25T14:52:56.000Z",
              "name": "Example product",
              "product_variation_id": 1
            }
          ],
          "despatch_instructions": "Always pack facing upwards.",
          "discontinued_date": "2019-11-25T14:52:56.000Z",
          "id": 1,
          "modified": "2019-11-25T14:52:56.000Z",
          "product_id": 1,
          "product_variation_type_id": 1,
          "sku": "DEMO-SKU-01",
          "status": "active",
          "type": {
            "created": "2019-11-25T14:52:56.000Z",
            "id": 1,
            "modified": "2019-11-25T14:52:56.000Z",
            "name": "Standard Product",
            "type": "product"
          }
        }
      }
    ],
    "order": {
      "channel": {
        "created": "2019-11-25T14:52:56.000Z",
        "id": 321,
        "modified": "2019-11-25T14:52:56.000Z",
        "name": "Demo Channel",
        "organisation": {
          "active": true,
          "contact_email": "joe.bloggs@example.com",
          "contact_mobile": "+44 00000000",
          "contact_name": "Mr Joe Bloggs",
          "contact_phone": "+44 01425 000 000",
          "created": "2019-11-25T14:52:56.000Z",
          "id": 1,
          "modified": "2019-11-25T14:52:56.000Z",
          "name": "Demo",
          "notes": "Demo account...",

Scope(s): APP::ORDERS::MANAGE

Query Parameters

expandstringquery

Usage: expand=*

Expand attributes, lines, lines.variation, lines.variation.descriptions, lines.variation.descriptions.locale, lines.variation.type, order, order.channel, order.channel.organisation, shipments, shipments.shipping_service, shipments.shipping_service.courier_account, shipments.shipping_service.courier_account.courier, shipping_address, shipping_address.country, shipping_address.country.region, tags, warehouse

Body

attributesany

List of attributes.

bulk_optionsany

Options for bulk goodsouts.

date_placedanyrequired

Customer placed date.

delivery_instructionsstring

Delivery instructions.

despatch_instructionsstring

Despatch instructions.

gift_messagestring

Gift message. If presented, gift_message_template_shortcode is required.

gift_message_template_shortcodestring

Shortcode for the gift message template to be used. If presented, gift_message is required.

import_optionsany

Import options.

linesanyrequired

The list of products.

metadataany

Goodsout metadata.

orderanyrequired

Order.

picking_instructionsstring

Picking instructions.

retailerinteger

Retailer

shippingany

Shipping data.

shipping_addressanyrequired

Customer shipping address.

tagsany

List of tags to be applied to the goodsout.

typeany

Type.

warehousestringrequired

Warehouse short code.

Response

successful operation

attributesany

List of attributes.

cancellation_dateany

The date a goodsout was cancelled.

date_placedany

Placed date.

delivery_instructionsstring

Delivery instructions.

despatch_dateany

Despatch date.

despatch_on_dateany

Despatch on date.

gift_messagestring

Gift message.

idnumber

ID.

linesany

List of lines.

orderobject

Order.

retailer_idnumber

ID of the retailer the goodsout is destined for. Null when the goodsout has no retailer.

shipmentsany

List of shipments.

shipping_addressobject

Shipping Address.

Show child attributes

sourcestring

Source.

statusenum<string>

Status.

Available options: draft, awaiting_allocation, hung, returned, awaiting_payment, awaiting_picking, awaiting_despatch, backorder_release, backorder, cancelled, return_open, item_refunded, item_replaced, awaiting_collection, despatched

tagsany

Applied tags.

typeenum<string>

Goodsout type, as set when the goodsout was created.

Available options: consumer, trade, retail

warehouseobject

Warehouse.

Still need help? Share an idea