OrderMesh
    OrderMesh
    • Introduction to OrderMesh API
      • Getting Started
      • Product Catalog
      • Webhooks
      • Merchant Notifications Guide
    • Notes
      • /v1/notes
      • /v1/notes
      • /v1/notes/{noteId}
      • /v1/notes/{id}
      • /v1/notes/{id}
      • /v1/notes/{id}/auditLogs
    • OrderItems
      • Search for order items based on various criteria and filters
    • Orders
      • Create a New Order.
      • Search for orders based on various criteria and filters.
      • Create multiple orders
      • Retrieve multiple orders
      • Update multiple orders
      • Retrieve a list of orders
      • Retrieve an order by Order ID.
      • Update order data.
      • Retrieve an order by Safe ID
      • Retrieve order item by Order Item ID
      • Update an item within an order.
      • Cancel Order or order items
      • Change the order status to Customer Care Hold
      • Retrieve audit logs for a specific order.
      • Retrieve audit logs for a specific order.
      • Retrieve audit logs for a specific order item.
      • Add a Refund Request.
    • 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.
      • 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
      • Generate service client access token (valid for 24 hours).
    • User
      • Login user by username and password.
      • Login user with refresh token.
    • 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

    AddRefundModel

    {
        "orderId": "string",
        "refunds": [
            {
                "itemId": "string",
                "isShippingRefund": true,
                "amount": 0,
                "reason": "string"
            }
        ]
    }
    Built with