- Introduction to OrderMesh API
- Notes
- OrderItems
- Orders
- Create a New Order.POST
- Search for orders based on various criteria and filters.GET
- Create multiple ordersPOST
- Retrieve multiple ordersGET
- Update multiple ordersPATCH
- Retrieve a list of ordersGET
- Retrieve an order by Order ID.GET
- Update order data.PATCH
- Retrieve an order by Safe IDGET
- Retrieve order item by Order Item IDGET
- Update an item within an order.PATCH
- Cancel Order or order itemsPOST
- Change the order status to Customer Care HoldPOST
- 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
- Create a New Order.
- Packing Slip
- 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.
- 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.
- Client
- User
- Schemas
- CreateNoteModel
- APIClientInfoModel
- AssignDTO
- AssignUserRoleDto
- CreateNoteReponse
- AddRefundItemModel
- AssignShipmentResponse
- Error
- AddRefundModel
- ForbiddenErrorResponse
- AddressModel
- ClientTokenResponseDTO
- GetAuditLogResponse
- AttributeModel
- CancelShipmentDto
- GetNoteByIdResponse
- BaseAddressModel
- CreateInvitationDto
- GetNoteResponseItemModel
- BillingInfoModel
- CountryCodes
- CreateInvitationDtoBulkModel
- GetNotesResponse
- BulkResponse
- CreatePackageDTO
- CreateInvitationResponse
- NotFoundErrorResponse
- BulkResponseItem
- CreatePackagesResponse
- CreateRoleDTO
- ResourceFormat
- CancelOrderItemModel
- CreateShipmentDTO
- CreateServiceClientDto
- ResourceReferenceModel
- CancelOrderModel
- CreateShipmentResponse
- CreateServiceClientResponseDTO
- StringAuditEvent
- CancelOrderResponse
- CurrencyCodes
- CreateUserDto
- UnauthorizedResult
- ConflictErrorResponse
- DeleteInvitationResponse
- UnhandledErrorResponse
- CoordinatesModel
- ExternalErrorResponse
- UpdateNotePayload
- CreateOrderCustomerPaymentMethodModel
- UpdateNoteResponse
- CreateOrderCustomerTransactionModel
- GeneratePackingSlipResponse
- UserReferenceModel
- CreateOrderItemImageModel
- ForgotPasswordDTO
- ValidationErrorResponse
- CreateOrderItemModel
- GetOrdersCountByFacilityResponse
- FutureAssociationsDTO
- CreateOrderModel
- GetShipmentPollingStoppedCountResponse
- GetInvitationResponse
- CreateOrderModelBulkModel
- GetShipmentsCountByStatusResponse
- GetInvitationsByMerchantIdResponse
- CreateOrderResponse
- LanguageCodes
- GetInvitationsByMerchantIdResponseDto
- CustomerCareHoldOrderResponse
- GetServiceClientTokenDto
- OrderCount
- InvitationDeliveryMethodEnum
- OrderItem
- InvitationDeliveryResponse
- OrderItemDTO
- InvitationStatusEnum
- GetOrderCustomerPaymentMethodModel
- PackageDTO
- InvitationsByMerchantIdSortByEnum
- GetOrderCustomerTransactionModel
- PackageOrderItemDTO
- LoginUserDto
- GetOrderItemImageModel
- PackingSlipDto
- LoginUserWithAuthorizationCode
- GetOrderItemModel
- Price
- LoginUserWithRefreshToken
- GetOrderItemRefundDataItemModel
- Reject
- GetOrderItemRefundDataModel
- RejectResponse
- OnboardUserDto
- GetOrderItemResponse
- Reroute
- PasswordPolicyDTO
- GetOrderModel
- RerouteBulkModel
- PatchUserDTO
- GetOrderResponse
- RerouteOrderItem
- PermissionDTO
- GetOrdersCountByStatusResponse
- RerouteResponse
- PermissionSet
- GetOrdersPollingStoppedCountResponse
- PermissionSetsRequestDTO
- ListOrderModel
- SearchShipmentModel
- PermissionSetsResponseDTO
- ListOrdersResponse
- SearchShipmentResponse
- ResendInvitationResponse
- SelectedCarrierShippingServiceMethodDTO
- ResetPasswordDTO
- OptionModel
- SelectedShippingMappingDTO
- ResourceDTO
- OrderItemStatus
- SelectedShippingMappingMethodDTO
- RoleDTO
- OrderStatus
- SelectedVendorMappingDTO
- RolePermissionDTO
- OrdersCountByStatus
- ShipmentDTO
- RoleWithPermissionDTO
- PriceModel
- ShipmentStatus
- SearchRolesEnum
- RefreshProcessingModel
- ShipmentsCountByStatus
- SearchRolesResponseDTO
- RefreshProcessingResponse
- SearchUsersEnum
- ReprintCostCoverageModel
- UnassignOrderItemDTO
- SearchUsersResponseDTO
- ReprintModel
- ServiceClientResponseDTO
- ReprintShipmentItemModel
- StringBulkModel
- ReprintShipmentModel
- UpdatePackageDTO
- TokenResponseDTO
- UpdateShipmentDTO
- UnassignUserRoleDTO
- SearchOrderItemsResponse
- UnauthorizedErrorResponse
- SearchOrderModel
- SearchOrdersResponse
- ShipmentMetadata
- UpdateAssociationTypeDTO
- StartProcessingModel
- UpdateAttributesDto
- StartProcessingResponse
- UpdateRoleDTO
- UpdateRolePermissionsDTO
- UserResponseDTO
- ValidateEmailsResponse
- UpdateOrderItemImageModel
- UpdateOrderItemModel
- ValidationResponseDTO
- UpdateOrderItemResponse
- UpdateOrderModel
- UpdateOrderModelBulkModel
- UpdateOrderResponse
- UpdatePriceModel
- VariantAttribute
- VariantOption
/v1/notes
POST
/v1/notes
Request
Body Params application/json
Examples
Responses
🟢201Created
text/plain
Body
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.dev.ordermesh.io/v1/notes' \
--header 'Content-Type: application/json' \
--data-raw '{
"content": "Customer address issue could not be fixed automatically. Manual intervention required. Merchant has been notified to reach out to the customer for confirmation.",
"isPrivate": false,
"resourceReference": {
"entityType": "Order",
"entityId": "6686def3cb6eb9b3d1740f96",
"merchantId": "6e0a8bd9-93b1-4f60-9af0-ea9cd5c4756a",
"vendorId": "33ba401a-28fd-4129-b335-5cd7b81c45af"
}
}'Response Response Example
201 - Success Example
{
"id": "0a0d1c4d-4557-4386-bc80-e26937d08411"
}Modified at 2026-03-06 14:23:17