1. Orders
Marketplace
  • Getting an API token
  • Introduction
  • Customers
    • Get a list of Customer Fields
      GET
    • Retrieve Customer Fields matching the given ID
      GET
    • Get a list of Customers
      GET
    • Retrieve Customers matching the given ID
      GET
    • Update a Customer
      PUT
    • Delete a Customer
      DELETE
    • Bulk Add/Update Customers
      POST
    • Create a new Customer
      POST
    • Get a list of Orders
      GET
  • Distributors
    • Get a list of Distributors
      GET
    • Retrieve Distributors matching the given ID
      GET
    • Update a Distributor
      PUT
    • Delete a Distributor
      DELETE
    • Create a new Distributor
      POST
  • Warehouses
    • Get a list of Warehouses
      GET
    • Retrieve Warehouses matching the given ID
      GET
    • Update a Warehouse
      PUT
    • Delete a Warehouse
      DELETE
    • Bulk Add/Update Warehouses
      POST
    • Create a new Warehouse
      POST
  • Exports
    • Get available exports
    • Get parameter options
    • Run custom export
  • Orders
    • Get a list of Order Batches
      GET
    • Retrieve Order Batch matching the given order batch Ids (from orderBatches/list)
      GET
    • Update Order Batch status
      PUT
    • Delete Order Batch
      DELETE
    • Create a new Order
      POST
    • Update an existing Order
      PUT
    • Bulk Add/Update Orders
      POST
    • Bulk Update Order Batch Statuses
      POST
  • People
    • Get a list of People
    • Retrieve a specific Person by ID
    • Update a Person
    • Delete a Person
    • Create a new Person
    • Bulk Add/Update Persons
    • Get a list of roles
    • Get a list of person types
    • Retrieve a specific Person Type by ID
  • Products
    • Get a list of Products
    • Create a new Product
    • Bulk Add/Update Products
    • Retrieve Products matching the given ID
    • Update a Product
    • Delete a Product
    • Get a list of Product Skus
    • Create a new Product Sku
    • Update a Product Sku
    • Bulk Add/Update Product Skus
    • Get a list of Pricing information for a given product
    • Bulk Add/Update Pricing
    • Get a list of categories
    • Get a list of brands
    • Get a list of PriceZones
    • Get a list of Product Fields
    • Get a list of Product Sku Fields
    • Get a list of product options
    • Retrieve a product option matching the given ID
    • Update a product option
    • Delete a product option
    • Create a new product option
    • Update Pricing for a product that starts on a given date
    • Create new Pricing for a product
    • Delete Pricing for a product that starts on a given date
    • Retrieve a field matching the given ID
    • Add or update the component SKUs linked to a kit Product
    • Bulk Add/Update the component SKUs linked to kit Products, across any number of kits
  • Vendors
    • Get a list of Vendors
    • Retrieve Vendors matching the given ID
    • Update a Vendor
    • Delete a Vendor
    • Bulk Add/Update Vendors
    • Create a new Vendor
  • Content
  • Promotions
    • Get a list of Promotions
    • Retrieve the Promotion matching the given ID
    • Get a list of Deals linked to the given Promotion
    • Retrieve the Deal matching the given ID under the given Promotion
    • Update the Deal's details, and optionally its status. Card and banner appearance stays inherited from the Promotion
    • Bulk Add/Update fixed price Deals under the given Promotion
    • Set the Deal's fixed price reward, with a price per product
    • Add products to the Deal's fixed price reward pool
    • Set the Deal's warehouses, price zones, customers and delivery dates in one call
  • Imports
  • Product Skus
    • Retrieve Fields matching the given ID
    • Retrieve Product Skus matching the given ID
    • Delete a Product Sku
    • Bulk Add/Update Product Skus across multiple Products
  • Pricing
    • Retrieve Pricing for a product that starts on a given date
    • Bulk Add/Update Pricing across multiple products
  • PriceZones
    • Retrieve PriceZone by ID
  • Product Highlights
    • Get a list of product highlights
    • Add products to the product highlight with a name, creating it if there is none
    • Add products to a product highlight
  • Product Options
  • Schemas
    • Schemas
      • Export
      • ExportParameter
      • PriceAssociatedProductSku
      • PriceList
      • Pricing
    • BulkFailMessage
    • AddressApiInput
    • DealAvailability
    • BulkSkippedProduct
    • SelectionItem
    • ProductOption
    • Customer
    • Address
    • Country
    • State
    • Distributor
    • FreeStock
    • OrderBatch
    • OrderLine
    • Person
    • PersonType
    • PricingMutation
    • ProductSku
    • Vendor
    • Warehouse
    • WarehouseUnderDistributor
    • BulkUpdateResult
    • Deal
    • DealBulkItemApiInput
    • DealUpdateApiInput
    • FIELD_TYPE
    • PERMISSION
    • PriceListMutation
    • ProductSkuApiInput
    • SELECTION_TYPE
    • DealAvailabilityApiInput
    • BulkSuccessItem
    • DealBulkApiInput
    • CompleteOrder
    • DealDateRange
    • CompleteOrderApiInput
    • DealDeliveryDateRangeApiInput
    • CompleteOrderBulkApiInput
    • DealPagedResults
    • CompleteOrderQuantityApiInput
    • DealProductPrice
    • CompleteOrderWithIdApiInput
    • DealProductPriceApiInput
    • DealProductsApiInput
    • DealReward
    • CustomerApiInput
    • CustomerAssociation
    • ENTITY_STATUS
    • CustomerAssociationApiInput
    • EntityAssociationResult
    • CustomerBulkApiInput
    • FIELD_COMPONENT
    • CustomerOrdering
    • CustomerOrderingApiInput
    • CustomerRule
    • Field
    • CustomerRuleApiInput
    • FieldComponent
    • CustomersConnection
    • KitComponent
    • PagedResults
    • DistributorPagedResults
    • PriceZone
    • ENTITY_STATUS_WITH_TEST
    • PricingCrossProductBulkApiInput
    • Email
    • ProductKitComponentApiInput
    • Error
    • ProductKitComponentBulkApiInput
    • ProductKitComponentCrossProductBulkApiInput
    • ProductSkuCrossProductBulkApiInput
    • Promotion
    • PromotionPagedResults
    • REWARD_APPLY
    • RolePermission
    • ORDER_STATUS
    • Section
    • OrderBatchStatusApiInput
    • Selection
    • OrderBatchStatusBulkApiInput
    • VISIBILITY
    • OrdersConnection
    • PRODUCT_SKU_STATUS_RAW
    • PersonApiInput
    • PersonBulkApiInput
    • PersonRule
    • PersonRuleApiInput
    • PersonTypeAssociation
    • PersonTypeAssociationApiInput
    • PersonsConnection
    • Phone
    • PriceAssociatedProductSkuMutation
    • PriceZonePagedResults
    • PricingBulkApiInput
    • PricingPagedResults
    • Product
    • ProductApiInput
    • ProductAssociation
    • ProductAssociationApiInput
    • ProductBulkApiInput
    • ProductHighlight
    • ProductHighlightByNameApiInput
    • ProductHighlightByNameResult
    • ProductHighlightPagedResults
    • ProductHighlightProductsApiInput
    • ProductOptionApiInput
    • ProductPagedResults
    • ProductRule
    • ProductRuleApiInput
    • ProductSkuBulkApiInput
    • SelectionPagedResults
    • VALIDATION_STATUS
    • ValidationProblemDetails
    • VendorApiInput
    • VendorBulkApiInput
    • VendorBulkItemApiInput
    • VendorPagedResults
    • WarehouseApiInput
    • WarehouseBulkApiInput
    • WarehouseBulkDistributorApiInput
    • WarehouseBulkItemApiInput
    • WarehousePagedResults
    • WarehouseSkuId
  1. Orders

Update Order Batch status

PUT
/v1/orderBatches/{id}/status

Sets the status of the order batch whose id, -, is in the route, and answers the batch. The body is the status code as a JSON string, such as "SENT"; one that isn't a valid status is refused with the list of valid codes.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
OK
Bodyapplication/json

🟠400Bad Request
🟠401Record Not Found
🟠404
🟠429
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://marketplacerest.perenso.net/v1/orderBatches//status' \
--header 'Content-Type: application/json' \
--data 'SENT'
Response Response Example
200 - Success Example
{
    "id": "1042-1",
    "deliveryDate": "2026-11-20T00:00:00+11:00",
    "status": "SENT",
    "isTest": false,
    "promo": {
        "id": "PROMO-SUMMER26",
        "name": "Summer Stock-Up 2026"
    },
    "lastStatusChangeDate": "2026-11-16T11:15:03+11:00",
    "customer": {
        "id": "CUST-1001",
        "name": "Harbourside Grocers"
    },
    "distributor": {
        "id": "DIST-NSW",
        "name": "Coastal Distribution"
    },
    "warehouse": {
        "id": "WH-SYD",
        "name": "Sydney DC"
    },
    "orderLines": [
        {
            "productCore": {
                "id": "PRD-330",
                "name": "Sparkling Water Lemon"
            },
            "productSku": {
                "id": "SKU-24-330",
                "name": "Sparkling Water Lemon 24 x 330ml"
            },
            "listPrice": 28.5,
            "salePrice": 24.9,
            "quantity": 12
        }
    ],
    "freeStock": [
        {
            "productCoreID": "PRD-330",
            "productSkuID": "SKU-24-330",
            "listPrice": 28.5,
            "quantity": 1
        }
    ]
}
Modified at 2026-11-17 17:43:44
Previous
Retrieve Order Batch matching the given order batch Ids (from orderBatches/list)
Next
Delete Order Batch
Built with