Orders

Create Goodsout (minimal response)

Creates an order goodsout and returns minimal information about it.

POST

/v1/orders/goodsouts/minimal

curl --request POST \
  --url https://public-api.bladepro.io/v1/orders/goodsouts/minimal \
  --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": {
    "goodsout_ids": [
      1049789
    ],
    "order_id": 1234567
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

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

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

goodsout_idsany

Goodsout IDs.

order_idnumber

Order ID.

Still need help? Share an idea