OGOship Api
    OGOship Api
    • Using OGOship OpenAPI
    • ApiV1
      • Metadata
        • Get metadata
        • Update metadata
        • Delete metadata
      • Orders
        • Search orders
        • Create order
        • Update order
        • Update order
      • Products
        • Search products
        • Add new product
        • Update product
      • Returns
        • Search returns
        • Create return
        • Update return
      • Stock
        • Search stock levels
      • StockUpdate
        • /StockUpdate
        • Add stock update (purchase order)
      • WebHooks
        • List active webhook subscriptions. (Check responses 501-505 for webhook callback models)
        • Add webhook
        • Get webhook info
        • Update webhook
        • Remove webhook
    • Tracking Service
      • Providers
        • Returns provider data by it's name
        • Get steps for tracking provider
        • Get step for tracking provider
        • Get step for tracking provider
        • Get missing steps for tracking provider
        • Update provider step
      • Shipments
        • Get shipment
        • Update shipment
        • Create shipment. Tracking is not done instantly, but in background.
        • Metrics of shipments per day
        • Search shipments
        • Set merchant issue in shipment
        • Reset shipment tracking by replacing it parcels with a new ones
      • Trackings
        • Get tracking data for parcel. Will rerun tracking if it is not up to date.
        • Get tracking data for parcel using token. Will rerun tracking if it is not up to date.
    • Order Service
      • Claims
        • File a new claim based on orderId
        • Get claims by orderId
        • Get claim
        • Update claim
        • Create or update claim
        • Get claims search definitions
        • Get filtered claims
        • Cancel claim.
        • Refund claim to ecom.
        • Get new claims dashboard data for a channel
        • Set owner for a claim
        • Remove owner from a claim
        • Run action on claims
        • Add a tag to a customer claim
        • Remove a tag from a customer claim
      • Emission
        • Get merchant emission data for dashboard
        • Get emission dummy data for dashboard
      • Fabrikator
        • List all approved purchase orders
        • Get a purchase order
        • Generate stock update for a purchase order
      • Label
        • /label/{LabelType}/GetLabel
        • /{channelId}/label/{LabelType}/ReturnLabel
      • Location
        • Find locations where return can be made.
        • Find pick up points for outgoing orders
      • Order
        • Set order tracking status and tracking time
        • Create exchange order
        • Send exchange order (set to NEW status in myOGO1)
        • Cancel order in myOGO1
        • Stop (move to RESERVED status) order in myOGO1
        • Search orders. Channel number specifies the location to search from.
        • Get order by string orderId
        • Create external order
        • Update external order
        • Get external order by orderId
        • Get external orders by channelId
      • ReturnDeliveryTypes
        • Get single return delivery type
        • Update return delivery type. (Admins only)
        • Delete (disable) return delivery type. (Admins only)
        • Get a return delivery types by warehouse
        • Add new return delivery type. (Admins only)
        • Get all return delivery types. (Admins only)
      • Returns
        • Change refund status of both return orders
        • Gets list of returns
        • Get filter definitions for front end search
        • Search for orders with defined filters
        • Gets return dashboard data
        • Get return by id
        • Gets return dashboard data
        • Get myOgo2 return by returnId
        • Update a myOGO2 return
        • Get myOgo2 returns by orderId (Full info for admins or merchants)
        • Get myOgo2 returns by orderId (customer version)
        • Request a new return. Checks merchant settings and creates a return to myOGO1 if the status of the return is WAITING.
        • Get channels myOgo2 returns
        • Run actions for returns
        • Get filter definitions for front end search
        • Approve requested return order.
        • Close requested return order.
        • Change return order back to requested status.
        • Cancel return order.
        • Create return to ecom.
        • Complete return at ecom.
        • Create shipment to tracking service from return order.
        • Merge returns.
        • Update exchange order to be sent in ecom and/or myOGO.
        • Create or update draft return order
        • Initialize return from claim
        • Initialize return from order
        • Finish draft return
        • Create exchange order (admin only)
        • Send notification to customer about return order
        • Get open returns dashboard data for a channel
        • Set owner for a return
        • Remove owner from a return
        • Add a tag to a return order
        • Remove a tag from a return order
      • Shipment
        • Get shipment data for dashboard
        • Get shipment dashboard data in excel
        • Get shipment dashboard filters
    • Notification Service
      • ChannelEvents
        • Create a new channel event subscription
        • Update an existing channel event subscription
        • Get an existing channel event subscription by channel ID
        • Get all available channel event options for a specific channel
        • /channel-events/{channelId}/templates
        • /channel-events/{channelId}/trigger
      • Chat
        • Get chat conversation by id
        • Create or update chat conversation (Admin or system only)
        • Update an existing chat conversation
        • Delete chat conversation (Admin or system only)
        • Get chat conversation by id with messages
        • Get chat messages for a conversation
        • Get all chat conversations for a channel
        • Create a new chat conversation
        • Add a single message to an existing chat conversation
        • Set feedback on a chat message
        • /chat/{channelId}/dashboard
      • KlaviyoApi
        • Configure Klaviyo integration for a channel with API keys
        • Get Klaviyo account details for a channel
        • Get lists from Klaviyo
        • Get segments from Klaviyo
        • Get email templates from Klaviyo
        • Create or update a profile in Klaviyo
        • Add a profile to a list
        • Send a transactional email through Klaviyo
        • Track a custom event in Klaviyo
        • Update account metrics from Klaviyo
        • Remove Klaviyo integration for a channel
      • Messaging
        • Getting message by id
        • Search messages by context id
      • Notifications
        • Send message directly (Admin or internal only)
        • Send raw message directly (Admin or internal only)
        • Test notification sending (Channel authentication)
      • NotificationSettings
        • Get list of notification providers
        • Get default model for provider
        • Get default model
        • Get channel notification settings
        • Create channel notification settings
        • Update channel notification settings
        • Delete channel notification settings
        • /settings/copy
      • NotificationTemplate
        • Get frame for editor
        • Update existing frame
        • Remove existing frame
        • Get frame for editor
        • Update existing template
        • Get all templates by channel id
        • Get all frames by channel id
        • Add new template
        • Add new frame
        • Preview frame
        • Preview template
        • Preview template to email/SMS
        • Get sample model
        • Copy all frames from another channel Overwrite: true will overwrite existing frames, false will only copy missing frames
        • Copy all templates from another channel Overwrite: true will overwrite existing templates, false will only copy missing templates
        • Delete all old frames and templates and copy new ones from source channel to target channel Overwrite input has no effect
        • /notificationTemplates/ogoTemplates
        • /notificationTemplates/ogoUsageKeys
      • SlackApi
        • Generates a Slack OAuth authorization link for the user to authorize the application.
        • Handles the OAuth callback from Slack after user authorization
        • /SlackApi/{channelId}/channels
        • /SlackApi/{channelId}/details
        • Removes the Slack integration for the specified channel
        • /SlackApi/{channelId}/send
      • Transactional
        • Creates new message
        • Gets message
        • Updates existing message if exist
        • Getting message by id
        • Marking message as deleted
        • Get all active messages using merchantId identifier. Marks all as read.
        • Add transaction to message using merchantId identifier. (Draft = 0, Sent = 1, Read = 2, Skipped = 3, Agreed = 4, Rejected = 5)
        • Get's all recipients of message (Draft = 0, Sent = 1, Read = 2, Skipped = 3, Agreed = 4, Rejected = 5)
        • Adds recipient to message Returns list of recipients
        • Updates all recipients for message
        • Simplified add recipient Returns list of recipients for current merchant
        • Simplified add recipient Returns list of recipients for current merchant
        • Create transaction
        • Create transaction
        • Generates message token (DEV_ONLY) Crashes API
      • WebHook
        • Creates new message
        • Get all messages
        • Delete messages
        • Get all messages statuses
        • Resend all messages
      • ZendeskApi
        • Generates a Zendesk OAuth authorization link for the user to authorize the application.
        • Handles the OAuth callback from Zendesk after user authorization
        • Get tickets from Zendesk for a channel
        • Get Zendesk account details for a channel
        • Get available groups from Zendesk
        • Create a new ticket in Zendesk
        • Add a comment to an existing ticket
        • Update a ticket's status
        • Removes the Zendesk integration for the specified channel
    • Schemas
      • Schemas
        • AddCommentRequest
        • AddToListRequest
        • ChannelEventOption
        • ChannelEventOptionTemplate
        • ChannelEventSubscriptionTemplate
        • ChannelEventSubscriptionsDto
        • ChannelNotificationsSettingsDto
        • ChannelNotificationsSettingsUpdateDto
        • ProblemDetails
        • ChatConversationDto
        • ChatConversationUpdateDto
        • ChatMessageDto
        • ChatParticipantDto
        • ConfigureKlaviyoRequest
        • ConversationDashboardDto
        • ConversationMetadataDto
        • ConversationMetadataUpdateDto
        • CopySettings
        • CreateProfileRequest
        • CreateTicketRequest
        • CreateTransactionalMessageModel
        • CustomWebhookMessage
        • EChannelEventOptionType
        • EContentType
        • EMessageApproval
        • EMessageReceiver
        • EMessageRecipientStatus
        • EMessageRecipientType
        • EMessageSource
        • EMessageType
        • EventDeliveryTypeDto
        • EventSubscriptionDto
        • Feedback
        • FileAttachmentDto
        • FrameDetails
        • KlaviyoAccountPublicDetails
        • LocaleString
        • MessageContentDto
        • MessageContext
        • MessageDto
        • MessageFeedbackDto
        • NotificationChannels
        • NotificationFrameDto
        • NotificationProviderSettingsDto
        • NotificationTemplateDto
        • ProviderResponse
        • ProvidersListResponse
        • RecipientTransactionsDto
        • SendAttachmentDto
        • SendDto
        • SendEmailRequest
        • SendRawDto
        • SendTestDto
        • SlackTeam
        • SlackTeamPublicDetails
        • StringStringKeyValuePair
        • TemplateLocalizedString
        • TrackEventRequest
        • TransactionDto
        • TransactionalMessageContentDto
        • TransactionalMessageDto
        • UiDataField
        • UiDataFieldOption
        • UpdateTicketStatusRequest
        • WebHookRedisListModel
        • WebHookStatus
        • ZendeskAccountPublicDetails

    Using OGOship OpenAPI

    OGOship has an open API for developers. You can update products, orders and webhooks through the API.

    Test account and merchant#

    Please create a free test account and a merchant profile to myOGO. You can generate and copy a new secret token at the merchant setting edit page in your myOGO account.
    .Net standard 2.0 library can be found: Github or as a Nuget package.
    PHP sample can be found on GitHub.

    Generating authentication token#

    The API uses an JWT token for authentication. Currently, it is possible to use a Resource owner password based flow to generate a token. The token is valid for 1.5 hours and must be refreshed after that time. The refresh token is valid for 2 weeks and for one refresh. The new refresh token is returned after each refresh.
    Use https://my.ogoship.com server for token requests.
    We only support form data and parameter data types (not json currently) for generating the token.

    WebHooks#

    You can find webhook models in the API description. API calls will have a "X-OGOship-Hmac-SHA256" header.
    It will contain body of message HMACSHA256 calculated using Webhook key. Hash is then saved to header using Base64 encoding.
    C# implementation:
    var bytes = Encoding.UTF8.GetBytes(webhookSecretKey);
    var hmac = new HMACSHA256(bytes);
    var hashString = Convert.ToBase64String(hmac.ComputeHash(Encoding.UTF8.GetBytes(data)));
    Your own Application ID and secret
    You can test everything with a demo account client_id/client_secret = 123456/abcdef .
    Before you wish to go live, request your own client ID & secret via email from our Tech team.
    When authorizing Ogoship API in swagger:

    APIauthorizations#

    You can find the username & password from your myOGO merchant, under Edit Merchant --> Integrations --> API Information.

    API documentation#

    In case of any issues, please email our Tech team for assistance.
    Modified at 2024-11-29 07:54:00
    Next
    Get metadata
    Built with