1. Orders
OrderMesh QA
  • User
    • Client
      • Generate Service Client Access Token
    • User
      • Login User by Username and Password
      • Login User with Refresh Token
    • Schemas
      • AssignUserRoleDto
      • BulkResponse
      • BulkResponseItem
      • ClientTokenResponseDTO
      • ConflictErrorResponse
      • CreateInvitationDto
      • CreateInvitationDtoBulkModel
      • CreateInvitationResponse
      • CreateRoleDTO
      • CreateServiceClientDto
      • CreateServiceClientResponseDTO
      • CreateUserDto
      • CreateVendorInvitationDto
      • CreateVendorInvitationDtoBulkModel
      • CreateVendorInvitationResponse
      • DeleteInvitationResponse
      • DeleteVendorInvitationResponse
      • Error
      • ExternalErrorResponse
      • ForbiddenErrorResponse
      • ForgotPasswordDTO
      • FutureAssociationsDTO
      • GetInvitationResponse
      • GetInvitationsByMerchantIdResponse
      • GetInvitationsByMerchantIdResponseDto
      • GetServiceClientTokenDto
      • GetVendorInvitationResponse
      • GetVendorInvitationsByVendorIdResponse
      • GetVendorInvitationsByVendorIdResponseDto
      • InvitationDeliveryMethodEnum
      • InvitationDeliveryResponse
      • InvitationStatusEnum
      • InvitationsByMerchantIdSortByEnum
      • LoginUserDto
      • LoginUserWithAuthorizationCode
      • LoginUserWithRefreshToken
      • NotFoundErrorResponse
      • OnboardUserDto
      • PasswordPolicyDTO
      • PatchUserDTO
      • PermissionDTO
      • PermissionSet
      • PermissionSetsRequestDTO
      • PermissionSetsResponseDTO
      • ResendInvitationResponse
      • ResendVendorInvitationResponse
      • ResetPasswordDTO
      • ResourceDTO
      • RoleDTO
      • RolePermissionDTO
      • RoleWithPermissionDTO
      • SearchRolesEnum
      • SearchRolesResponseDTO
      • SearchUsersEnum
      • SearchUsersResponseDTO
      • ServiceClientResponseDTO
      • StringBulkModel
      • TokenResponseDTO
      • UnassignUserRoleDTO
      • UnauthorizedErrorResponse
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdateAssociationTypeDTO
      • UpdateAttributesDto
      • UpdateRoleDTO
      • UpdateRolePermissionsDTO
      • UserResponseDTO
      • ValidateEmailsResponse
      • ValidationErrorResponse
      • ValidationResponseDTO
  • Order
    • OrderItems
      • Search for order items based on various criteria and filters
    • Orders
      • Create a New Order.
        POST
      • Search for orders based on various criteria and filters.
        GET
      • Create multiple orders
        POST
      • Retrieve multiple orders
        GET
      • Update multiple orders
        PATCH
      • Retrieve a list of orders
        GET
      • Retrieve an order by Order ID.
        GET
      • Update order data.
        PATCH
      • Retrieve an order by Safe ID
        GET
      • Retrieve order item by Order Item ID
        GET
      • Update an item within an order.
        PATCH
      • Cancel Order or order items
        POST
      • Change the order status to Customer Care Hold
        POST
      • Retrieve audit logs for a specific order.
        GET
      • Retrieve audit logs for a specific order.
        GET
      • Retrieve audit logs for a specific order item.
        GET
      • Add a Refund Request.
        POST
    • Schemas
      • APIClientInfoModel
      • AddRefundItemModel
      • AddRefundModel
      • AddressModel
      • AttributeModel
      • BaseAddressModel
      • BillingInfoModel
      • BulkResponse
      • BulkResponseItem
      • CancelOrderItemModel
      • CancelOrderModel
      • CancelOrderResponse
      • ConflictErrorResponse
      • CoordinatesModel
      • CreateOrderCustomerPaymentMethodModel
      • CreateOrderCustomerTransactionModel
      • CreateOrderItemImageModel
      • CreateOrderItemModel
      • CreateOrderModel
      • CreateOrderModelBulkModel
      • CreateOrderResponse
      • CustomerCareHoldOrderResponse
      • Error
      • ForbiddenErrorResponse
      • GetAuditLogResponse
      • GetOrderCustomerPaymentMethodModel
      • GetOrderCustomerTransactionModel
      • GetOrderItemImageModel
      • GetOrderItemModel
      • GetOrderItemRefundDataItemModel
      • GetOrderItemRefundDataModel
      • GetOrderItemResponse
      • GetOrderModel
      • GetOrderResponse
      • GetOrdersCountByStatusResponse
      • GetOrdersPollingStoppedCountResponse
      • ListOrderModel
      • ListOrdersResponse
      • NotFoundErrorResponse
      • OptionModel
      • OrderItemStatus
      • OrderStatus
      • OrdersCountByStatus
      • PriceModel
      • RefreshProcessingModel
      • RefreshProcessingResponse
      • ReprintCostCoverageModel
      • ReprintModel
      • ReprintShipmentItemModel
      • ReprintShipmentModel
      • ResourceFormat
      • SearchOrderItemsResponse
      • SearchOrderModel
      • SearchOrdersResponse
      • ShipmentMetadata
      • StartProcessingModel
      • StartProcessingResponse
      • StringAuditEvent
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdateOrderItemImageModel
      • UpdateOrderItemModel
      • UpdateOrderItemResponse
      • UpdateOrderModel
      • UpdateOrderModelBulkModel
      • UpdateOrderResponse
      • UpdatePriceModel
      • ValidationErrorResponse
      • VariantAttribute
      • VariantOption
  • Note
    • Notes
      • Create a New Note
      • Search All Notes
      • View Note by ID
      • Update Note
      • Delete Note
      • View Note Audit Logs
    • Schemas
      • CreateNoteModel
      • CreateNoteReponse
      • Error
      • ForbiddenErrorResponse
      • GetAuditLogResponse
      • GetNoteByIdResponse
      • GetNoteResponseItemModel
      • GetNotesResponse
      • NotFoundErrorResponse
      • ResourceFormat
      • ResourceReferenceModel
      • StringAuditEvent
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdateNotePayload
      • UpdateNoteResponse
      • UserReferenceModel
      • ValidationErrorResponse
  • Catalog
    • Categories
      • View all product categories
      • Create a new category
      • Update category
      • Delete category
      • Get audit logs of a category
    • MerchantCatalog
      • Create a merchant catalog
      • Update a merchant catalog
      • Partially update a merchant catalog
      • Get a list of merchant catalogs
      • Delete a merchant catalog
      • Get a merchant catalog and search variants in it
      • Get a merchant catalog with variants
      • Get a list of variants the merchant can use in accordance with their enabled catalog
      • Search for variants in enabled merchant catalog with fallback to global catalog
      • Get audit logs of a merchant catalog
    • Products
      • View all products
      • Retrieve product variant details
      • Create a new product
      • Search products
      • Bulk create products
      • Bulk update products
      • Update product
      • Delete product
      • Update variant
      • Get audit logs of a product
    • Variants
      • Delete variant
      • Create a variant
      • Search product variants
      • Get audit logs of a variant
    • Schemas
      • BulkResponse
      • BulkResponseItem
      • CategoryModel
      • CreateCategoryModel
      • CreateCategoryResponse
      • CreateMerchantCatalogDto
      • CreateMerchantCatalogResponse
      • CreateProductModel
      • CreateProductModelBulkModel
      • CreateProductResponse
      • CreateVariantModel
      • CreateVariantResult
      • DecorationModel
      • Error
      • ForbiddenErrorResponse
      • GetAuditLogResponse
      • GetCategoriesResponse
      • GetEffectiveProductsResponse
      • GetEffectiveVariantListResponse
      • GetEffectiveVariantsByProductResponse
      • GetProductVariantsResponse
      • GetProductsResponse
      • ListMerchantCatalogsResponse
      • MerchantCatalogDto
      • MerchantVariantAttributeDto
      • MerchantVariantDto
      • MultiPrice
      • MultiPriceModel
      • NotFoundErrorResponse
      • PatchMerchantCatalogDto
      • PatchMerchantCatalogResponse
      • Price
      • PriceModel
      • PrintImageModel
      • PrintImageUploadStatus
      • PrintMethod
      • ProductAttributeModel
      • ProductAttributeValueModel
      • ProductExtraModel
      • ProductModel
      • ProductStatus
      • ResourceFormat
      • SearchEffectiveVariantsDto
      • SearchEffectiveVariantsResponse
      • SearchEffectiveVariantsSeparateDto
      • SearchEffectiveVariantsSeparateResponse
      • SearchMerchantCatalogVariantsResponse
      • SearchMerchantVariantDto
      • SearchProductsResponse
      • SearchVariantsModel
      • StringAuditEvent
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdateCategoryModel
      • UpdateMerchantCatalogDto
      • UpdateMerchantCatalogResponse
      • UpdateProductModel
      • UpdateProductModelBulkModel
      • UpdateProductResponse
      • UpdateProductVariantModel
      • UpdateProductVariantResponse
      • ValidationErrorResponse
      • VariantAttributeModel
      • VariantModel
  • Shipment
    • Packing Slip
      • Generates a packing slip for a specific shipment by Shipment ID.
    • Shipments
      • Get details of a specific shipment by Shipment ID.
      • Update details of a specific shipment by Shipment ID.
      • Create packages for a specific shipment.
      • Delete shipment with packages.
      • Get all shipments for an order by Order ID.
      • Create shipment for order, vendor, and order items.
      • Get shipment with packages for order and vendor.
      • Get shipment details by Order Item ID.
      • Update a specific shipment package.
      • Delete a specific shipment package.
      • Cancel shipment.
      • Unassign items to shipment.
      • Shipment resubmission to assigned facility.
      • Retry outbound polling for a shipment by publishing an OutboundShipmentUpdate event.
      • Search shipments.
      • Reroute shipment.
      • Rejects a shipment.
      • Bulk reroute shipments.
      • Get shipment audit logs.
      • Get package audit logs.
      • Get message audit logs for shipment updates.
      • Assign Shipment.
    • Schemas
      • AssignDTO
      • AssignShipmentResponse
      • BulkResponse
      • BulkResponseItem
      • CancelShipmentDto
      • ConflictErrorResponse
      • CountryCodes
      • CreatePackageDTO
      • CreatePackagesResponse
      • CreateShipmentDTO
      • CreateShipmentResponse
      • CurrencyCodes
      • Error
      • ExternalErrorResponse
      • ForbiddenErrorResponse
      • GeneratePackingSlipResponse
      • GetAuditLogResponse
      • GetOrdersCountByFacilityResponse
      • GetShipmentPollingStoppedCountResponse
      • GetShipmentsCountByStatusResponse
      • GetVendorShipmentsCountByStatusResponse
      • LanguageCodes
      • NotFoundErrorResponse
      • OrderCount
      • OrderItem
      • OrderItemDTO
      • OrderItemImage
      • OrderItemImageDTO
      • OrderItemStatus
      • PackageDTO
      • PackageOrderItemDTO
      • PackingSlipDto
      • Price
      • Reject
      • RejectResponse
      • ReprintDTO
      • Reroute
      • RerouteBulkModel
      • RerouteOrderItem
      • RerouteResponse
      • ResourceFormat
      • SearchShipmentModel
      • SearchShipmentResponse
      • SelectedCarrierShippingServiceMethodDTO
      • SelectedShippingMappingDTO
      • SelectedShippingMappingMethodDTO
      • SelectedVendorMappingDTO
      • ShipmentDTO
      • ShipmentStatus
      • ShipmentsCountByStatus
      • ShippingAddressDTO
      • StringAuditEvent
      • UnassignOrderItemDTO
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdatePackageDTO
      • UpdateShipmentDTO
      • ValidationErrorResponse
      • VendorOrderItemModel
      • VendorPackageModel
      • VendorRejectShipmentDTO
      • VendorSearchShipmentModel
      • VendorSearchShipmentResponse
      • VendorShipmentResponse
      • VendorUpdateTrackingDTO
  • Schemas
    • Notes
      • /v1/notes
      • /v1/notes
      • /v1/notes/{noteId}
      • /v1/notes/{id}
      • /v1/notes/{id}
      • /v1/notes/{id}/auditLogs
    • Schemas
      • CreateNoteModel
      • CreateNoteReponse
      • Error
      • ForbiddenErrorResponse
      • GetAuditLogResponse
      • GetNoteByIdResponse
      • GetNoteResponseItemModel
      • GetNotesResponse
      • NotFoundErrorResponse
      • ResourceFormat
      • ResourceReferenceModel
      • StringAuditEvent
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdateNotePayload
      • UpdateNoteResponse
      • UserReferenceModel
      • ValidationErrorResponse
  1. Orders

Update order data.

PATCH
/v1/orders/{orderId}
This API request allows you to send a PATCH request to orders endpoint and update order data or order items data in a single order.

Request

Path Params

Body Params
application/json

Examples

Responses

🟢200
application/json
OK
Body

🟠400
🟠401
🟠403
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.qa.ordermesh.io/order/v1/orders/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "65aac2a2441de72442397b62",
    "shippingAddress": {
        "location": null,
        "firstName": "Jane",
        "lastName": "Doe",
        "line1": "123 Maple Street",
        "line2": "",
        "line3": null,
        "city": "Springfield",
        "state": "IL",
        "zip": "62704",
        "countryCode": "US",
        "phone": "555-1234",
        "email": "jane.doe@example.com"
    },
    "billingAddress": {
        "location": null,
        "firstName": "Jane",
        "lastName": "Doe",
        "line1": "123 Maple Street",
        "line2": "",
        "line3": null,
        "city": "Springfield",
        "state": "IL",
        "zip": "62704",
        "countryCode": "US",
        "phone": "555-1234",
        "email": "billing@example.com"
    },
    "returnAddress": {
        "location": null,
        "firstName": "John",
        "lastName": "Smith",
        "line1": "456 Oak Street",
        "line2": "Suite 300",
        "line3": null,
        "city": "Shelbyville",
        "state": "IL",
        "zip": "62565",
        "countryCode": "US",
        "phone": "555-6789",
        "email": "return@example.com"
    },
    "location": {
        "longitude": -89.64,
        "latitude": 39.78
    },
    "merchantName": "Springfield Boutique",
    "customerShippingMethod": "Expedited",
    "status": "ReadyForFulfillment",
    "items": [
        {
            "id": "65aac2a2441de72442397b63",
            "sku": "TSHIRT-5000-M-Black",
            "quantity": 1,
            "images": [
                {
                    "url": "https://example.com/tshirt-front.jpg",
                    "thumbnailUrl": "https://example.com/tshirt-thumbnail.jpg",
                    "thumbnailFileId": null,
                    "area": "Front",
                    "printMethod": "DirectToGarment",
                    "ourUrl": null,
                    "ourFileId": null,
                    "ourThumbnailUrl": null,
                    "ourThumbnailFileId": null,
                    "vendorReadyFileId": null
                }
            ],
            "options": [
                {
                    "name": "Size",
                    "value": "Medium"
                },
                {
                    "name": "Color",
                    "value": "Black"
                }
            ],
            "attributes": [
                {
                    "name": "Material",
                    "value": "Cotton"
                }
            ],
            "merchantPrice": {
                "amount": 15,
                "currency": "USD"
            },
            "merchantShippingPrice": {
                "amount": 2.5,
                "currency": "USD"
            },
            "merchantTax": {
                "amount": 1.2,
                "currency": "USD"
            },
            "status": null,
            "statusDesc": null,
            "skipImgManip": false,
            "skipImageValidation": false,
            "skipSkuValidation": false
        }
    ],
    "shipmentsMetadata": [
        {
            "shipmentId": "shipment-123",
            "facilityName": "Main Warehouse",
            "shipmentCreatedDate": "2026-04-04T05:28:59.7233687Z",
            "shortId": "S12345",
            "shipmentExternalId": "EXT-999"
        }
    ],
    "isPollingStopped": true
}'
Response Response Example
200 - Success
{
    "updated": true
}
Modified at 2026-05-27 12:48:23
Previous
Retrieve an order by Order ID.
Next
Retrieve an order by Safe ID
Built with