FlavorCloud Partner API Documentation

Update Batch - Add Shipment

PUT

/Batches/{batchId}

ShipmentBatchesController

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

batchId

string

required

Body Params application/json

ShipmentsToAdd

array[object (ShipmentsModel) {3}]

optional

Piece

array[object (Piece) {12}]

required

Package

object (ShipmentPackage)

required

ITNNumber

string

optional

ITNNumber

ReferencesToRemove

array[string]

optional

Example

{
  "AppID": "{{app_id}}",
  "RestApiKey": "{{rest_api_key}}",
  "ShipmentsToAdd": [
    {
      "Piece": [
        {
          "Quantity": 1,
          "Weight": 0.1,
          "Description": "Xbox  Official Laptop Backpack",
          "Material": "Xbox  Official Laptop Backpack",
          "Category": [
            "Xbox  Official Laptop Backpack"
          ],
          "SKU": "8-1",
          "SalePrice": 60.99,
          "HSCode": "420292",
          "OriginCountryCode": "US"
        }
      ],
      "Package": {
        "Weight": 0.5,
        "Length": 2,
        "Width": 3,
        "Height": 4,
        "Reference": "{{package_reference}}"
      }
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://partnerapi.flavorcloud.com/Batches/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "AppID": "{{app_id}}",
    "RestApiKey": "{{rest_api_key}}",
    "ShipmentsToAdd": [
        {
            "Piece": [
                {
                    "Quantity": 1,
                    "Weight": 0.1,
                    "Description": "Xbox  Official Laptop Backpack",
                    "Material": "Xbox  Official Laptop Backpack",
                    "Category": [
                        "Xbox  Official Laptop Backpack"
                    ],
                    "SKU": "8-1",
                    "SalePrice": 60.99,
                    "HSCode": "420292",
                    "OriginCountryCode": "US"
                }
            ],
            "Package": {
                "Weight": 0.5,
                "Length": 2,
                "Width": 3,
                "Height": 4,
                "Reference": "{{package_reference}}"
            }
        }
    ]
}'

Responses

🟢204Update batch

application/json

Body

object {0}

Example

{}

Modified at 2025-04-28 20:49:53

Create Batch

Update Batch - Remove Shipment